diff options
| author | engelsman <engelsman> | 2009-03-28 16:40:06 +0000 |
|---|---|---|
| committer | engelsman <engelsman> | 2009-03-28 16:40:06 +0000 |
| commit | 165eed565c0b08d008e996093541ee28115d1f1f (patch) | |
| tree | 0dfde9aaabc2815794212a645541719f2c055cb8 /documentation/src | |
| parent | 88a23466e32dfde5c7b58c1e79a817c5aacb70fe (diff) | |
updated document conventions for doxygen recognised entities,
removed links to class/function reference from index/preface
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6728 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/src')
| -rw-r--r-- | documentation/src/index.dox | 8 | ||||
| -rw-r--r-- | documentation/src/preface.dox | 25 |
2 files changed, 18 insertions, 15 deletions
diff --git a/documentation/src/index.dox b/documentation/src/index.dox index 235eafd9e..bd3df9818 100644 --- a/documentation/src/index.dox +++ b/documentation/src/index.dox @@ -67,6 +67,8 @@ \subpage unicode + + <b>Appendices:</b> - \subpage enumerations @@ -89,12 +91,6 @@ - \subpage examples - <b>References:</b> - - - <b><a class="el" href="annotated.html">Class Reference</a></b> - - - <b><a class="el" href="globals_func.html">Function Reference</a></b> - </TD> </TR> </TABLE> diff --git a/documentation/src/preface.dox b/documentation/src/preface.dox index 3da2d16c7..167146125 100644 --- a/documentation/src/preface.dox +++ b/documentation/src/preface.dox @@ -37,18 +37,25 @@ This manual is organized into the following chapters and appendices: \li \ref development \li \ref license \li \ref examples -\li <A class="el" HREF="annotated.html">Class Reference</A> -\li <A class="el" HREF="functions.html#functions">Function Reference</A> -\todo Remove or reconfigure old HTML links as these are relative - to the source directories and fail in the PDF version! \section preface_conventions Conventions -The following typeface conventions are used in this manual: - -\li Function and constant names are shown in <B><TT>bold courier type</TT></B> -\li Code samples and commands are shown in <TT>regular courier type</TT> -\todo The old typeface conventions need to be rethought for doxygen. +This manual was generated using Doxygen +(see <a href="http://www.stack.nl/~dimitri/doxygen/"> +http://www.stack.nl/~dimitri/doxygen/</a>) +to process the source code itself, special comments in the code, +and additional documentation files. +In general, Doxygen recognizes and denotes the following entities as shown: +- classes, such as Fl_Widget, +- methods, such as Fl_Widget::callback(Fl_Callback* cb, void* p), +- functions, such as fl_draw(const char *str, int x, int y), +- internal links, such as \ref preface_conventions, +- external links, such as + <a href="http://www.stack.nl/~dimitri/doxygen/"> + http://www.stack.nl/~dimitri/doxygen/ + </a> + +Other code samples and commands are shown in <tt>regular courier type</tt>. \section preface_abbreviations Abbreviations |