mirror of
https://github.com/fltk/fltk.git
synced 2026-06-04 06:56:24 +08:00
Update documentation
- fix missing doxygen version in PDF docs created by CMake
- remove unnecessary quotes ('...') from version numbers and
Git revisions (previously added for debugging purposes)
- fix navigation links at the bottom of tutorial pages (HTML only)
- remove 'D. Gibson' from documentation headers on his request
This commit is contained in:
@@ -161,6 +161,12 @@ if(FLTK_BUILD_PDF_DOCS)
|
|||||||
|
|
||||||
# convert Doxybook to current doxygen version
|
# convert Doxybook to current doxygen version
|
||||||
|
|
||||||
|
# set DOXY_VERSION for compatibility with configure/make,
|
||||||
|
# to be replaced in fltk-title.tex.in
|
||||||
|
# FIXME: this can be simplified when configure/make is no longer supported
|
||||||
|
|
||||||
|
set(DOXY_VERSION "${DOXYGEN_VERSION_SHORT}") #
|
||||||
|
|
||||||
add_custom_command(
|
add_custom_command(
|
||||||
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE}
|
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE}
|
||||||
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
<br>
|
<br>
|
||||||
<small>
|
<small>
|
||||||
Generated on @CURRENT_DATE@
|
Generated on @CURRENT_DATE@
|
||||||
from Git revision '@FLTK_GIT_REVISION@'
|
from Git revision @FLTK_GIT_REVISION@
|
||||||
by Doxygen version '@DOXYGEN_VERSION_SHORT@'
|
by Doxygen version @DOXYGEN_VERSION_SHORT@
|
||||||
</small>
|
</small>
|
||||||
|
|||||||
@@ -121,6 +121,11 @@ will be shown as:
|
|||||||
<!-- *** This *** is *** invisible *** -->
|
<!-- *** This *** is *** invisible *** -->
|
||||||
This will be visible again.
|
This will be visible again.
|
||||||
|
|
||||||
|
\note Since an unknown Doxygen version indentation by four or more bytes
|
||||||
|
is automatically displayed as if it was framed by \\code and \\endcode.
|
||||||
|
You need to take care that "normal" text is not indented that much to
|
||||||
|
avoid mis-interpretation and formatting as code.
|
||||||
|
|
||||||
|
|
||||||
<H3>Different Headlines</H3>
|
<H3>Different Headlines</H3>
|
||||||
|
|
||||||
@@ -190,7 +195,7 @@ links \b from normal (e.g. class) documentation \b to documentation sections
|
|||||||
|
|
||||||
This page has
|
This page has
|
||||||
\code
|
\code
|
||||||
\page development I - Developer Information
|
\page development Developer Information
|
||||||
\endcode
|
\endcode
|
||||||
at its top.
|
at its top.
|
||||||
|
|
||||||
@@ -307,7 +312,9 @@ Each introduction (tutorial) page ends with navigation elements. These
|
|||||||
elements must only be included in the html documentation, therefore
|
elements must only be included in the html documentation, therefore
|
||||||
they must be separated with \\htmlonly and \\endhtmlonly.
|
they must be separated with \\htmlonly and \\endhtmlonly.
|
||||||
|
|
||||||
The following code gives the navigation bar at the bottom of this page:
|
The following code creates the navigation bar at the bottom of the
|
||||||
|
\ref basics HTML page as an example of all pages in the "FLTK Programming Manual"
|
||||||
|
section. Note that \b this \b page is one of the appendices w/o navigation bar.
|
||||||
|
|
||||||
\verbatim
|
\verbatim
|
||||||
\htmlonly
|
\htmlonly
|
||||||
@@ -315,17 +322,17 @@ The following code gives the navigation bar at the bottom of this page:
|
|||||||
<table summary="navigation bar" width="100%" border="0">
|
<table summary="navigation bar" width="100%" border="0">
|
||||||
<tr>
|
<tr>
|
||||||
<td width="45%" align="LEFT">
|
<td width="45%" align="LEFT">
|
||||||
<a class="el" href="migration_1_4.html">
|
<a class="el" href="intro.html">
|
||||||
[Prev]
|
[Prev]
|
||||||
Migrating Code from FLTK 1.3 to 1.4
|
Introduction to FLTK
|
||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td width="10%" align="CENTER">
|
<td width="10%" align="CENTER">
|
||||||
<a class="el" href="index.html">[Index]</a>
|
<a class="el" href="index.html">[Index]</a>
|
||||||
</td>
|
</td>
|
||||||
<td width="45%" align="RIGHT">
|
<td width="45%" align="RIGHT">
|
||||||
<a class="el" href="license.html">
|
<a class="el" href="common.html">
|
||||||
Software License
|
Common Widgets and Attributes
|
||||||
[Next]
|
[Next]
|
||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
@@ -334,28 +341,4 @@ The following code gives the navigation bar at the bottom of this page:
|
|||||||
\endhtmlonly
|
\endhtmlonly
|
||||||
\endverbatim
|
\endverbatim
|
||||||
|
|
||||||
|
|
||||||
\htmlonly
|
|
||||||
<hr>
|
|
||||||
<table summary="navigation bar" width="100%" border="0">
|
|
||||||
<tr>
|
|
||||||
<td width="45%" align="LEFT">
|
|
||||||
<a class="el" href="migration_1_4.html">
|
|
||||||
[Prev]
|
|
||||||
Migrating Code from FLTK 1.3 to 1.4
|
|
||||||
</a>
|
|
||||||
</td>
|
|
||||||
<td width="10%" align="CENTER">
|
|
||||||
<a class="el" href="index.html">[Index]</a>
|
|
||||||
</td>
|
|
||||||
<td width="45%" align="RIGHT">
|
|
||||||
<a class="el" href="license.html">
|
|
||||||
Software License
|
|
||||||
[Next]
|
|
||||||
</a>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
\endhtmlonly
|
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -807,7 +807,7 @@ image drawing example:
|
|||||||
<a class="el" href="index.html">[Index]</a>
|
<a class="el" href="index.html">[Index]</a>
|
||||||
</td>
|
</td>
|
||||||
<td width="45%" align="RIGHT">
|
<td width="45%" align="RIGHT">
|
||||||
<a class="el" href="faq.html">
|
<a class="el" href="FAQ.html">
|
||||||
Frequently Asked Questions
|
Frequently Asked Questions
|
||||||
[Next]
|
[Next]
|
||||||
</a>
|
</a>
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
\end{DoxyImageNoCaption}\\
|
\end{DoxyImageNoCaption}\\
|
||||||
\vspace*{2cm}
|
\vspace*{2cm}
|
||||||
{\Large
|
{\Large
|
||||||
By F. Costantini, D. Gibson, M. Melcher, \\
|
By F. Costantini, M. Melcher, \\
|
||||||
A. Schlosser, B. Spitzak, and M. Sweet.}\\
|
A. Schlosser, B. Spitzak, and M. Sweet.}\\
|
||||||
\vspace*{1.5cm}
|
\vspace*{1.5cm}
|
||||||
{\large Copyright © 1998 - @YEAR@ by Bill Spitzak and others.}\\
|
{\large Copyright © 1998 - @YEAR@ by Bill Spitzak and others.}\\
|
||||||
@@ -27,7 +27,7 @@ provided this copyright and permission notice are preserved.}\\
|
|||||||
\vspace*{0.5cm}
|
\vspace*{0.5cm}
|
||||||
\today{}\\
|
\today{}\\
|
||||||
\vspace*{0.5cm}
|
\vspace*{0.5cm}
|
||||||
{\small Git revision '@FLTK_GIT_REVISION@'}\\
|
{\small Git revision @FLTK_GIT_REVISION@}\\
|
||||||
\end{center}
|
\end{center}
|
||||||
\end{titlepage}
|
\end{titlepage}
|
||||||
%
|
%
|
||||||
|
|||||||
@@ -235,7 +235,7 @@ Switches all drawing functions to the GLUT window.
|
|||||||
<td width="45%" align="LEFT">
|
<td width="45%" align="LEFT">
|
||||||
<a class="el" href="enumerations.html">
|
<a class="el" href="enumerations.html">
|
||||||
[Prev]
|
[Prev]
|
||||||
FLTK Enumerations
|
Constants and Enumerations
|
||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td width="10%" align="CENTER">
|
<td width="10%" align="CENTER">
|
||||||
|
|||||||
@@ -10,7 +10,7 @@
|
|||||||
<TD><CENTER>
|
<TD><CENTER>
|
||||||
<B>FLTK 1.4.0 Programming Manual</B>
|
<B>FLTK 1.4.0 Programming Manual</B>
|
||||||
|
|
||||||
By F. Costantini, D. Gibson, M. Melcher,
|
By F. Costantini, M. Melcher,
|
||||||
A. Schlosser, B. Spitzak and M. Sweet.
|
A. Schlosser, B. Spitzak and M. Sweet.
|
||||||
|
|
||||||
\include{doc} copyright.dox
|
\include{doc} copyright.dox
|
||||||
|
|||||||
@@ -497,9 +497,9 @@ DAMAGES.
|
|||||||
<table summary="navigation bar" width="100%" border="0">
|
<table summary="navigation bar" width="100%" border="0">
|
||||||
<tr>
|
<tr>
|
||||||
<td width="45%" align="LEFT">
|
<td width="45%" align="LEFT">
|
||||||
<a class="el" href="development.html">
|
<a class="el" href="migration_1_4.html">
|
||||||
[Prev]
|
[Prev]
|
||||||
Developer Information
|
Migrating Code from FLTK 1.3 to 1.4
|
||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td width="10%" align="CENTER">
|
<td width="10%" align="CENTER">
|
||||||
|
|||||||
@@ -317,8 +317,8 @@ OPTION_WAYLAND_ONLY | FLTK_BACKEND_X11=OFF
|
|||||||
<a class="el" href="index.html">[Index]</a>
|
<a class="el" href="index.html">[Index]</a>
|
||||||
</td>
|
</td>
|
||||||
<td width="45%" align="RIGHT">
|
<td width="45%" align="RIGHT">
|
||||||
<a class="el" href="development.html">
|
<a class="el" href="license.html">
|
||||||
Developer Information
|
Software License
|
||||||
[Next]
|
[Next]
|
||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
|
|||||||
@@ -525,7 +525,7 @@ converts the strings to lower case Unicode as part of the comparison.
|
|||||||
</td>
|
</td>
|
||||||
<td width="45%" align="RIGHT">
|
<td width="45%" align="RIGHT">
|
||||||
<a class="el" href="enumerations.html">
|
<a class="el" href="enumerations.html">
|
||||||
FLTK Enumerations
|
Constants and Enumerations
|
||||||
[Next]
|
[Next]
|
||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
<br>
|
<br>
|
||||||
<small>
|
<small>
|
||||||
Generated on @CURRENT_DATE@
|
Generated on @CURRENT_DATE@
|
||||||
from Git revision '@FLTK_GIT_REVISION@'
|
from Git revision @FLTK_GIT_REVISION@
|
||||||
by Doxygen version '@DOXYGEN_VERSION_SHORT@'
|
by Doxygen version @DOXYGEN_VERSION_SHORT@
|
||||||
</small>
|
</small>
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
\end{DoxyImageNoCaption}\\
|
\end{DoxyImageNoCaption}\\
|
||||||
\vspace*{2cm}
|
\vspace*{2cm}
|
||||||
{\Large
|
{\Large
|
||||||
By F. Costantini, D. Gibson, M. Melcher, \\
|
By F. Costantini, M. Melcher, \\
|
||||||
A. Schlosser, B. Spitzak, and M. Sweet.}\\
|
A. Schlosser, B. Spitzak, and M. Sweet.}\\
|
||||||
\vspace*{1.5cm}
|
\vspace*{1.5cm}
|
||||||
{\large Copyright © 1998 - @YEAR@ by Bill Spitzak and others.}\\
|
{\large Copyright © 1998 - @YEAR@ by Bill Spitzak and others.}\\
|
||||||
@@ -23,11 +23,11 @@ Permission is granted to reproduce this manual or any portion for any purpose,}\
|
|||||||
{\small
|
{\small
|
||||||
provided this copyright and permission notice are preserved.}\\
|
provided this copyright and permission notice are preserved.}\\
|
||||||
\vspace*{1.5cm}
|
\vspace*{1.5cm}
|
||||||
{\large Generated by Doxygen @DOXY_VERSION@}\\
|
{\large Generated by Doxygen @DOXYGEN_VERSION_SHORT@}\\
|
||||||
\vspace*{0.5cm}
|
\vspace*{0.5cm}
|
||||||
\today{}\\
|
\today{}\\
|
||||||
\vspace*{0.5cm}
|
\vspace*{0.5cm}
|
||||||
{\small Git revision '@FLTK_GIT_REVISION@'}\\
|
{\small Git revision @FLTK_GIT_REVISION@}\\
|
||||||
\end{center}
|
\end{center}
|
||||||
\end{titlepage}
|
\end{titlepage}
|
||||||
%
|
%
|
||||||
|
|||||||
@@ -16,7 +16,7 @@
|
|||||||
<TD><CENTER>
|
<TD><CENTER>
|
||||||
<B>FLUID 1.4.0 User Manual</B>
|
<B>FLUID 1.4.0 User Manual</B>
|
||||||
|
|
||||||
By F. Costantini, D. Gibson, M. Melcher,
|
By F. Costantini, M. Melcher,
|
||||||
A. Schlosser, B. Spitzak and M. Sweet.
|
A. Schlosser, B. Spitzak and M. Sweet.
|
||||||
|
|
||||||
Copyright © 1998 - 2024 by Bill Spitzak and others.
|
Copyright © 1998 - 2024 by Bill Spitzak and others.
|
||||||
|
|||||||
Reference in New Issue
Block a user