From 165eed565c0b08d008e996093541ee28115d1f1f Mon Sep 17 00:00:00 2001 From: engelsman Date: Sat, 28 Mar 2009 16:40:06 +0000 Subject: 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 --- documentation/src/index.dox | 8 ++------ 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 +   + Appendices: - \subpage enumerations @@ -89,12 +91,6 @@ - \subpage examples - References: - - - Class Reference - - - Function Reference - 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 Class Reference -\li Function Reference -\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 bold courier type -\li Code samples and commands are shown in regular courier type -\todo The old typeface conventions need to be rethought for doxygen. +This manual was generated using Doxygen +(see +http://www.stack.nl/~dimitri/doxygen/) +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 + + http://www.stack.nl/~dimitri/doxygen/ + + +Other code samples and commands are shown in regular courier type. \section preface_abbreviations Abbreviations -- cgit v1.2.3