Skip to content

Commit

Permalink
Adding a few links in the documentation
Browse files Browse the repository at this point in the history
Adding a few links to the documentation regarding configuration settings.
  • Loading branch information
albert-github committed Jun 2, 2023
1 parent cf818b6 commit c5cefba
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions doc/customize.doc
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions doc/diagrams.doc
Expand Up @@ -178,8 +178,7 @@ that doxygen can generate:

\htmlonly
Click <a href="examples/diagrams/html/annotated.html">here</a>
for the corresponding HTML documentation that is generated by doxygen<br/>
(<code>EXTRACT_ALL</code> = <code>YES</code> is used here).
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
\latexonly
\IfFileExists{../html/examples/diagrams/latex/refman_doc.tex}
Expand All @@ -188,6 +187,7 @@ See \hyperlink{diagrams_example}{Diagrams example}
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
} {}
\endlatexonly
Note \ref cfg_extract_all "EXTRACT_ALL" \c = \c YES is used to generate the diagrams.

\htmlonly
Go to the <a href="preprocessing.html">next</a> section or return to the
Expand Down
2 changes: 1 addition & 1 deletion doc/docblocks.doc
Expand Up @@ -134,7 +134,7 @@ or
***********************************************/
\endverbatim

as long as JAVADOC_BANNER = YES is used.
as long as \ref cfg_javadoc_banner "JAVADOC_BANNER" is set to \c YES.
\include javadoc-banner.h
\htmlonly
Click <a href="examples/javadoc-banner/html/javadoc-banner_8h.html">here</a>
Expand Down

0 comments on commit c5cefba

Please sign in to comment.