X-Git-Url: http://biod.pnpi.spb.ru/gitweb/?a=blobdiff_plain;f=docs%2Fdoxygen%2Flib%2Fdoxygen.md;fp=docs%2Fdoxygen%2Fdoxygen.md;h=f9583280ffa956b5bcab51656d9161cdac4fac0f;hb=301e6ab4c41152cfb791eaf6584abec08a96d652;hp=2373591a730037dcb81ac939aa0e193de3148e78;hpb=f1234c6422f448e3091d2bcd33053df2e1ad769e;p=alexxy%2Fgromacs.git diff --git a/docs/doxygen/doxygen.md b/docs/doxygen/lib/doxygen.md similarity index 99% rename from docs/doxygen/doxygen.md rename to docs/doxygen/lib/doxygen.md index 2373591a73..f9583280ff 100644 --- a/docs/doxygen/doxygen.md +++ b/docs/doxygen/lib/doxygen.md @@ -461,10 +461,11 @@ placed in the page hierarchy by making it a subpage of another page, i.e., it should be referenced once using \c \\subpage. `mainpage.md` is the root of the hierarchy. -If you need to exclude a page from the public API docs, you need to add it to -an exclude list in `Doxyfile-user.cmakein`, and ensure that there are no -references to the page from public API documentation. \c \\if `libapi` can be -used to add references in content that is otherwise public. +There are two subdirectories, `user/` and `lib/`, determining the highest +documentation level where the page appears. If you add pages to `lib/`, ensure +that there are no references to the page from public API documentation. +\c \\if `libapi` can be used to add references in content that is otherwise +public. Generally, the pages should be on a high enough level and provide overview content that is useful enough such that it is not necessary to exclude them from the library API documentation.