Skip to content

Commit 4b28c19

Browse files
committed
Consistency / links in LaTeX output of the doxygen documentation
- link under LaTeX the `\memberof` description to the example (like in HTML) - handle the source file analogous to e.g. the example with the `\overload` directory command - reduce space a little bit in the LaTeX introduction chapter of the manual (index.doc)
1 parent ad815cd commit 4b28c19

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

doc/commands.doc

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -610,7 +610,8 @@ Structural indicators
610610
when the programming language does not support this concept natively
611611
(e.g. C).
612612

613-
The file \c manual.c in the example directory shows how to use this command.
613+
The file \c manual.c in the example directory shows how to use this command
614+
(see also \ref cmdmemberof "\\memberof" for the complete file).
614615

615616
\htmlonly
616617
Click <a href="examples/manual/html/struct_car.html">here</a>
@@ -790,7 +791,8 @@ Structural indicators
790791
when the programming language does not support this concept natively
791792
(e.g. C).
792793

793-
The file \c manual.c in the example directory shows how to use this command.
794+
The file \c manual.c in the example directory shows how to use this command
795+
(see also \ref cmdmemberof "\\memberof" for the complete file).
794796

795797
\htmlonly
796798
Click <a href="examples/manual/html/struct_car.html">here</a>
@@ -898,12 +900,17 @@ Structural indicators
898900
\ref cmdpublic "\\public", \ref cmdprotected "\\protected" or
899901
\ref cmdprivate "\\private".
900902

901-
The file \c manual.c in the example directory shows how to use this command.
902-
903+
\par Example:
904+
The file \c manual.c in the example directory shows how to use this command:
905+
\include manual.c
903906
\htmlonly
904907
Click <a href="examples/manual/html/struct_car.html">here</a>
905908
for the corresponding HTML documentation that is generated by doxygen.
906909
\endhtmlonly
910+
\latexonly
911+
See \hyperlink{struct_car}{Car struct reference example}
912+
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
913+
\endlatexonly
907914

908915
\sa sections \ref cmdextends "\\extends", \ref cmdimplements "\\implements",
909916
\ref cmdpublic "\\public", \ref cmdprotected "\\protected" and

doc/index.doc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,13 @@
1818
\mainpage
1919
<!--Doxygen Manual-->
2020
\if logo_on
21-
<center>
2221
\htmlonly
22+
<center>
2323
<img src="doxygen_logo.svg" width="634" height="197" alt="doxygen"/><br/>
2424
Version: $(VERSION)
25-
\endhtmlonly
2625
</center>
26+
\endhtmlonly
2727
\endif
28-
2928
<h2>Introduction</h2>
3029
Doxygen is the de facto standard tool for generating documentation from
3130
annotated C++ sources, but it also supports other popular programming

0 commit comments

Comments
 (0)