X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fcustomize.doc;h=3396c4b0af3e3aa1ffd6b52f728d16bc151c593d;hb=14adf159fc9eb1212b2e61ea78e94c135abde0fe;hp=87c257f0d4765d43497e0e6febbe399198cc8712;hpb=cfd886868fa8595b045007a2ad673c18c5f222b3;p=platform%2Fupstream%2Fdoxygen.git diff --git a/doc/customize.doc b/doc/customize.doc index 87c257f..3396c4b 100644 --- a/doc/customize.doc +++ b/doc/customize.doc @@ -181,6 +181,7 @@ optionally the name of the layout file can be specified, if omitted \c DoxygenLayout.xml will be used. The next step is to mention the layout file in the configuration file +(see also \ref cfg_layout_file "LAYOUT_FILE") \verbatim LAYOUT_FILE = DoxygenLayout.xml \endverbatim @@ -397,15 +398,13 @@ its name prefixed with a dollar sign, e.g. This was mainly added for backward compatibility. Note that the \c visible attribute is just a hint for doxygen. If no relevant information is available for a certain piece it is -omitted even if it is set to \c yes (i.e. no empty sections are generated). +omitted even if it is set to \c yes (i.e. no empty sections are generated).
+Not all elements have a \c visible attribute shown in the layout file, though +this attribute can be used anyway (the default is `visible="yes"`). Some elements have a \c title attribute. This attribute can be used to customize the title doxygen will use as a header for the piece. -@warning at the moment you should not remove elements from the layout file -as a way to hide information. Doing so can cause broken links in the -generated output! - \section xmlgenerator Using the XML output @@ -436,7 +435,7 @@ files that you implicitly load via navigating through the index. As a result this works even for very large projects where reading all XML files as one big DOM tree would not fit into memory. -See the Breathe project for +See the Breathe project for an example that uses doxygen XML output from Python to bridge it with the Sphinx document generator.