From b804e1f3ab455a86dcd345710ee5dcc1c2eab606 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Sat, 20 Sep 2008 22:46:24 +0000 Subject: Fixed some typos and links and added a section about document structure and some more to development.dox. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6320 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/development.dox | 209 +++++++++++++++++++++++++++++------------- documentation/fluid.dox | 21 +++-- 2 files changed, 158 insertions(+), 72 deletions(-) (limited to 'documentation') diff --git a/documentation/development.dox b/documentation/development.dox index c869a1040..2bc512c01 100644 --- a/documentation/development.dox +++ b/documentation/development.dox @@ -116,92 +116,177 @@ Gizmo.cxx:

Example comment:

+You can use HTML comment statements to embed comments in doxygen comment blocks. +These comments will not be visible in the generated document. + + The following text is a developer comment. + + This will be visible again. + \code -The following text is a comment within a doxygen comment block and -will not appear in the generated document: - -This will be visible again. + The following text is a developer comment. + + This will be visible again. \endcode -The following text is a comment within a doxygen comment block and -will not appear in the generated document: - -This will be visible again. + +

Different Headlines:

\code -

Headline in big text

-

Headline in big text

-

Headline in big text

-

Headline in big text

+

Headline in big text (H1)

+

Headline in big text (H2)

+

Headline in big text (H3)

+

Headline in big text (H4)

\endcode -

Headline in big text

-

Headline in big text

-

Headline in big text

-

Headline in big text

+

Headline in big text (H1)

+

Headline in big text (H2)

+

Headline in big text (H3)

+

Headline in big text (H4)

+ + +\section development_non-ascii Non-ASCII characters + if you came here from below: back to \ref development_links -

Assuming that the following source code was written on MS Windows, -this example will output the correct label on OS X and X11 as well. -Without the conversion call, the label on OS X would read -Fahrvergn¸gen with a deformed umlaut u ("cedille", -html "¸"). \code - btn = new Fl_Button(10, 10, 300, 25); - btn->copy_label(fl_latin1_to_local("Fahrvergnügen")); + Doxygen understands many HTML quoting characters like + ", ü, ç, Ç, but not all HTML quoting characters. \endcode -\note If your application uses characters that are not part of both - encodings, or it will be used in areas that commonly use different - code pages, you might consider upgrading to FLTK 2 which supports - UTF-8 encoding. +This will appear in the document: -\todo This is an example todo entry, please ignore ! + Doxygen understands many HTML quoting characters like + ", ü, ç, Ç, but not all HTML quoting characters. -\code +For further informations about quoting see + \b http://www.stack.nl/~dimitri/doxygen/htmlcmds.html - +

Example with UTF-8 encoded text

-

Assuming that the following source code was written on MS Windows, -this example will output the correct label on OS X and X11 as well. -Without the conversion call, the label on OS X would read -Fahrvergn¸gen with a deformed umlaut u ("cedille", -html "¸"). \code - btn = new Fl_Button(10, 10, 300, 25); - btn->copy_label(fl_latin1_to_local("Fahrvergnügen")); -\endcode -\note If your application uses characters that are not part of both - encodings, or it will be used in areas that commonly use different - code pages, you might consider upgrading to FLTK 2 which supports - UTF-8 encoding. +

Assuming that the following source code was written on MS Windows, + this example will output the correct label on OS X and X11 as well. + Without the conversion call, the label on OS X would read + Fahrvergn¸gen with a deformed umlaut u ("cedille", + html "¸"). + \#code + btn = new Fl_Button(10, 10, 300, 25); + btn->copy_label(fl_latin1_to_local("Fahrvergnügen")); + \#endcode -\todo This is an example todo entry, please ignore ! + \note If your application uses characters that are not part of both + encodings, or it will be used in areas that commonly use different + code pages, you might consider upgrading to FLTK 2 which supports + UTF-8 encoding. -\endcode + \todo This is an example todo entry, please ignore ! +\endcode -

Creating Links

+This will appear in the document: + +

Assuming that the following source code was written on MS Windows, + this example will output the correct label on OS X and X11 as well. + Without the conversion call, the label on OS X would read + Fahrvergn¸gen with a deformed umlaut u ("cedille", + html "¸"). + \#code + btn = new Fl_Button(10, 10, 300, 25); + btn->copy_label(fl_latin1_to_local("Fahrvergnügen")); + \#endcode + + \note If your application uses characters that are not part of both + encodings, or it will be used in areas that commonly use different + code pages, you might consider upgrading to FLTK 2 which supports + UTF-8 encoding. + + \todo This is an example todo entry, please ignore ! + +\section development_structure Document Structure + + \li \b \\page creates a named page + \li \b \\section creates a named section within that page + \li \b \\subsection creates a named subsection within that page + +The page, section, and subsection titles are formatted in blue color and +a size like \b "

", \b "

", and \b "

", respectively. + +By FLTK documentation convention, a file like this one with a doxygen +documentation chapter has the name ".dox". +The \b \\page statement at the top of the page is +"\page This is the title". +Sections within a documentation page must be called \b "_
", +where \b "" is the name part of the file, and \b "
" is a +unique section name within the page that can be referenced in links. + +These doxygen page and section commands work only in special documentation +chapters, not within normal source or header documentation blocks. However, +links to documentation sections \b should work. + +\todo Verify, that links in (from) source documentation to documentation + pages and sections or subsections work. + +This page has + \code + \page development I - Developer Information + \endcode +at its top. + +This section is + \code + \section development_structure Document structure + \endcode + +The following section is + \code + \section development_links Creating Links + \endcode + +\section development_links Creating Links + +Links to other documents and external links can be embedded with + \li normal HTML links + \li HTML links without markup - doxygen creates "http://..." + links automatically + \li links to other doxygen chapters with the \\ref statments + \li links to named sections within the same or other doxygen chapters, + if they are defined there with a \\section statement \code -see chapter \ref unicode creates a link to the named chapter unicode -that has been created with a \subpage statement. - -see chapter 5 creates -a link to a named html anchor "character_encoding" within the same file. + see chapter \ref unicode creates a link to the named chapter unicode + that has been created with a \subpage statement. + + see chapter 5 creates + a link to a named html anchor "character_encoding" within the same file. + + For further informations about quoting see + http://www.stack.nl/~dimitri/doxygen/htmlcmds.html + + Bold link text: you can see the \e old online documentation + of FLTK 1.3 at \b http://www.fltk.org/doc-1.3/toc.html + + see section \ref development_non-ascii \endcode -see chapter \ref unicode creates a link to the named chapter unicode -that has been created with a \subpage statement. - -see chapter 5 creates -a link to a named html anchor "character_encoding" within the same file. +appears as: + + see chapter \ref unicode creates a link to the named chapter unicode + that has been created with a \\subpage statement. + + see chapter 5 creates + a link to a named html anchor "character_encoding" within the same file. + + For further informations about quoting see + http://www.stack.nl/~dimitri/doxygen/htmlcmds.html + + Bold link text: you can see the \e old online documentation + of FLTK 1.3 at \b http://www.fltk.org/doc-1.3/toc.html + + see section \ref development_non-ascii + + \subsection development_subsection_01 Subsection Number 1 + + Text in Subsection Number 1. */ diff --git a/documentation/fluid.dox b/documentation/fluid.dox index b29156713..17b25297d 100644 --- a/documentation/fluid.dox +++ b/documentation/fluid.dox @@ -10,23 +10,23 @@
  • What is FLUID
  • Running FLUID Under UNIX
  • Running FLUID Under Microsoft Windows
    • -
  • Compiling .fl files
    • +
  • Compiling .fl Files
  • A Short Tutorial
  • FLUID Reference
  • Internationalization with FLUID
    • -
  • Know limitations
    • +
  • Known Limitations

    • What is FLUID?

    The Fast Light User Interface Designer, or FLUID, is a graphical editor that is used to produce FLTK source code. FLUID -edits and saves its state in .fl files. These files +edits and saves its state in .fl files. These files are text, and you can (with care) edit them in a text editor, perhaps to get some special effects.

    FLUID can "compile" the .fl file into a -.cxx and a .h file. The .cxx file +.cxx and a .h file. The .cxx file defines all the objects from the .fl file and the .h file declares all the global ones. FLUID also supports localization (Internationalization) @@ -162,7 +162,7 @@ The CubeView class is a subclass of Fl_Gl_Window. It has methods for setting the zoom, the x and y pan, and the rotation angle about the x and yaxes.

    You can safely skip this section as long as you realize the CubeView -is a sublass of Fl_Gl_Window and will respond to calls from +is a sublass of Fl_Gl_Window and will respond to calls from CubeViewUI, generated by FLUID.

    The CubeView Class Definition

    Here is the CubeView class definition, as given by its header file @@ -405,16 +405,17 @@ shortly. defined the CubeView class and we would like to show it within the CubeViewUI. -

    The CubeView class inherits the Fl_Gl_Window class, which -is created in the same way as a Fl_Box widget. Use +

    The CubeView class inherits the Fl_Gl_Window class, which +is created in the same way as a Fl_Box widget. Use New->Other->Box to add a square box to the main window. This will be no ordinary box, however.

    The Box properties window will appear. The key to letting CubeViewUI display CubeView is to enter CubeView in the "Class:" text -entry box. This tells FLUID that it is not an Fl_Box, but a -similar widget with the same constructor. In the "Extra -Code:" field enter \#include "CubeView.h" +entry box. This tells FLUID that it is not an Fl_Box, but a +similar widget with the same constructor. + +In the "Extra Code:" field enter \#include "CubeView.h"

    This \#include is important, as we have just included CubeView as a member of CubeViewUI, so any public CubeView methods are -- cgit v1.2.3