Changeset 560 for trunk/Doc

Show
Ignore:
Timestamp:
02/26/07 14:29:12 (2 years ago)
Author:
dirk
Message:

Added doxygen support (first round)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk

    • Property svn:ignore changed from
      config.log
      .sconf_temp_linux
      build.linux
      .sconsign.*
      sconf.log_*
      .sconf_temp*
      option.cache.*
       to
      .sconf_temp*
      .sconsign.*
      build.*
      config.log
      option.cache.*
      sconf.log_*
      *.pyc

  • trunk/Doc

    • Property svn:ignore changed from
      html
       to
      html
      tracdocs
      docs

  • trunk/Doc/mainpage.dox

    r402 r560  
    4141 
    4242This documentation was generated for OpenSG 
    43 version 2.0.0-pre1 r398 (/trunk) !Modified! 
     43version 2.0.0-pre1 r439 (/trunk) !Modified! 
    4444. 
    4545 

  • trunk/Doc/opensg.doxy

    r456 r560  
    1515#--------------------------------------------------------------------------- 
    1616 
     17# This tag specifies the encoding used for all characters in the config file that  
     18# follow. The default is UTF-8 which is also the encoding used for all text before  
     19# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into  
     20# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of  
     21# possible encodings. 
     22 
     23DOXYFILE_ENCODING      = UTF-8 
     24 
    1725# The PROJECT_NAME tag is a single word (or a sequence of words surrounded  
    1826# by quotes) that should identify the project. 
    …… 
    2432# if some version control system is used. 
    2533 
    26 PROJECT_NUMBER         = 2.0 
     34PROJECT_NUMBER         = $(DOX_VERSION) 
    2735 
    2836# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)  
    …… 
    5462OUTPUT_LANGUAGE        = English 
    5563 
    56 # This tag can be used to specify the encoding used in the generated output.  
    57 # The encoding is not always determined by the language that is chosen,  
    58 # but also whether or not the output is meant for Windows or non-Windows users.  
    59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES  
    60 # forces the Windows encoding (this is the default for the Windows binary),  
    61 # whereas setting the tag to NO uses a Unix-style encoding (the default for  
    62 # all platforms other than Windows). 
    63  
    64 USE_WINDOWS_ENCODING   = NO 
    65  
    6664# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will  
    6765# include brief member descriptions after the members that are listed in  
    …… 
    7674# brief descriptions will be completely suppressed. 
    7775 
    78 REPEAT_BRIEF           = YES 
     76REPEAT_BRIEF           = NO 
    7977 
    8078# This tag implements a quasi-intelligent brief description abbreviator  
    …… 
    104102# description. 
    105103 
    106 ALWAYS_DETAILED_SEC    = NO 
     104ALWAYS_DETAILED_SEC    = YES 
    107105 
    108106# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all  
    …… 
    126124# path to strip. 
    127125 
    128 STRIP_FROM_PATH        = /home/allenb/Source/OpenSG2/Doc/ 
     126STRIP_FROM_PATH        =  
    129127 
    130128# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of  
    …… 
    149147# explicit @brief command for a brief description. 
    150148 
    151 JAVADOC_AUTOBRIEF      = YES 
     149JAVADOC_AUTOBRIEF      = NO 
    152150 
    153151# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen  
    …… 
    177175# all members of a group must be documented explicitly. 
    178176 
    179 DISTRIBUTE_GROUP_DOC   = NO 
     177DISTRIBUTE_GROUP_DOC   = YES 
    180178 
    181179# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce  
    …… 
    188186# Doxygen uses this value to replace tabs by spaces in code fragments. 
    189187 
    190 TAB_SIZE               = 8 
     188TAB_SIZE               = 4 
    191189 
    192190# This tag can be used to specify a number of aliases that acts  
    …… 
    203201                         "ext=\if ext\n<b>Ext:</b> " \ 
    204202                         endext=\n\endif \ 
    205                          guide="<A HREF='http://opensg.vrsource.org/trac/wiki/DevGuide/^1^'>^1^</A>" \ 
    206                          wiki="<A HREF='http://opensg.vrsource.org/trac/wiki/^1^'>^1^</A>" \                         
     203                         "guide=<A HREF='http://opensg.vrsource.org/trac/wiki/DevGuide/^1^'>^1^</A>" \ 
     204                         "wiki=<A HREF='http://opensg.vrsource.org/trac/wiki/^1^'>^1^</A>" \                         
    207205                          
    208206 
    …… 
    220218 
    221219OPTIMIZE_OUTPUT_JAVA   = NO 
     220 
     221# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to  
     222# include (a tag file for) the STL sources as input, then you should  
     223# set this tag to YES in order to let doxygen match functions declarations and  
     224# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.  
     225# func(std::string) {}). This also make the inheritance and collaboration  
     226# diagrams that involve STL classes more complete and accurate. 
     227 
     228BUILTIN_STL_SUPPORT    = YES 
     229 
     230# If you use Microsoft's C++/CLI language, you should set this option to YES to 
     231# enable parsing support. 
     232 
     233CPP_CLI_SUPPORT        = NO 
    222234 
    223235# Set the SUBGROUPING tag to YES (the default) to allow class member groups of  
    …… 
    297309# Set it to YES to include the internal documentation. 
    298310 
    299 INTERNAL_DOCS          = YES 
     311INTERNAL_DOCS          = NO 
    300312 
    301313# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate  
    …… 
    329341# declaration order. 
    330342 
    331 SORT_MEMBER_DOCS       = YES 
     343SORT_MEMBER_DOCS       = NO 
    332344 
    333345# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the  
    …… 
    469481# with spaces. 
    470482 
    471 INPUT                  = ../Source/ \ 
    472                          mainpage.dox 
     483INPUT                  = $(DOX_INPUT) 
    473484 
    474485# If the value of the INPUT tag contains directories, you can use the  
    …… 
    488499# If left blank NO is used. 
    489500 
    490 RECURSIVE              = YES 
     501RECURSIVE              = NO 
    491502 
    492503# The EXCLUDE tag can be used to specify files and/or directories that should  
    …… 
    599610REFERENCES_RELATION    = YES 
    600611 
     612# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
     613# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
     614# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
     615# link to the source code.  Otherwise they will link to the documentstion. 
     616 
     617REFERENCES_LINK_SOURCE = YES 
     618 
    601619# If the USE_HTAGS tag is set to YES then the references to source code  
    602620# will point to the HTML generated by the htags(1) tool instead of doxygen  
    …… 
    621639# contains a lot of classes, structs, unions or interfaces. 
    622640 
    623 ALPHABETICAL_INDEX     = NO 
     641ALPHABETICAL_INDEX     = YES 
    624642 
    625643# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then  
    …… 
    627645# in which this list will be split (can be a number in the range [1..20]) 
    628646 
    629 COLS_IN_ALPHA_INDEX    = 5 
     647COLS_IN_ALPHA_INDEX    = 1 
    630648 
    631649# In case all classes in a project start with a common prefix, all  
    …… 
    634652# should be ignored while generating the index headers. 
    635653 
    636 IGNORE_PREFIX          =  
     654IGNORE_PREFIX          = osg OSG 
    637655 
    638656#--------------------------------------------------------------------------- 
    …… 
    689707# of the generated HTML documentation. 
    690708 
    691 GENERATE_HTMLHELP      = YES 
     709### !!! This crashes and breaks the whole doc on 1.5.1 !!! 
     710# GENERATE_HTMLHELP      = YES 
     711GENERATE_HTMLHELP      = NO 
     712 
    692713 
    693714# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can  
    …… 
    703724# the HTML help compiler on the generated index.hhp. 
    704725 
    705 HHC_LOCATION           =  
     726HHC_LOCATION           = /bin/echo 
    706727 
    707728# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag  
    …… 
    789810# packages that should be included in the LaTeX output. 
    790811 
    791 EXTRA_PACKAGES         =  
     812EXTRA_PACKAGES         = times 
    792813 
    793814# The LATEX_HEADER tag can be used to specify a personal LaTeX header for  
    …… 
    803824# This makes the output suitable for online browsing using a pdf viewer. 
    804825 
    805 PDF_HYPERLINKS         = NO 
     826PDF_HYPERLINKS         = YES 
    806827 
    807828# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of  
    …… 
    965986# and Perl will parse it just the same. 
    966987 
    967 PERLMOD_PRETTY         = YES 
     988PERLMOD_PRETTY         = NO 
    968989 
    969990# The names of the make variables in the generated doxyrules.make file  
    …… 
    9951016# PREDEFINED and EXPAND_AS_PREDEFINED tags. 
    9961017 
    997 EXPAND_ONLY_PREDEF     = NO 
     1018EXPAND_ONLY_PREDEF     = YES 
    9981019 
    9991020# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files  
    …… 
    10331054                        OSG_DEBUG_ARG                     \ 
    10341055                        OSG_DO_DOC                        \ 
    1035                         DOXYGEN_SHOULD_SKIP_THIS          \ 
     1056                        DOXYGEN_SHOULD_SKIP_THIS 
    10361057 
    10371058# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then  
    …… 
    10401061# Use the PREDEFINED tag if you want to use a different macro definition. 
    10411062 
    1042 EXPAND_AS_DEFINED      =  
     1063EXPAND_AS_DEFINED      =    OSG_CHECK_ARG \ 
     1064                            OSG_BASELIB_DLLMAPPING \ 
     1065                            OSG_SYSTEMLIB_DLLMAPPING 
    10431066 
    10441067# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then  
    …… 
    11241147# the CLASS_DIAGRAMS tag to NO. 
    11251148 
    1126 CLASS_GRAPH            = NO 
     1149CLASS_GRAPH            = YES 
    11271150 
    11281151# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen  
    …… 
    11541177# other documented files. 
    11551178 
    1156 INCLUDE_GRAPH          = NO 
     1179INCLUDE_GRAPH          = YES 
    11571180 
    11581181# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and  
    …… 
    11611184# indirectly include this file. 
    11621185 
    1163 INCLUDED_BY_GRAPH      = NO 
     1186INCLUDED_BY_GRAPH      = YES 
    11641187 
    11651188# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will  
    …… 
    11711194CALL_GRAPH             = NO 
    11721195 
     1196# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will  
     1197# generate a caller dependency graph for every global function or class method.  
     1198# Note that enabling this option will significantly increase the time of a run.  
     1199# So in most cases it will be better to enable caller graphs for selected  
     1200# functions only using the \callergraph command. 
     1201 
     1202CALLER_GRAPH           = NO 
     1203 
    11731204# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen  
    11741205# will graphical hierarchy of all classes instead of a textual one. 
    11751206 
    1176 GRAPHICAL_HIERARCHY    = NO 
     1207GRAPHICAL_HIERARCHY    = YES 
    11771208 
    11781209# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES  
    …… 
    12001231DOTFILE_DIRS           =  
    12011232 
    1202 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width  
    1203 # (in pixels) of the graphs generated by dot. If a graph becomes larger than  
    1204 # this value, doxygen will try to truncate the graph, so that it fits within  
    1205 # the specified constraint. Beware that most browsers cannot cope with very  
    1206 # large images. 
    1207  
    1208 MAX_DOT_GRAPH_WIDTH    = 1024 
    1209  
    1210 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height  
    1211 # (in pixels) of the graphs generated by dot. If a graph becomes larger than  
    1212 # this value, doxygen will try to truncate the graph, so that it fits within  
    1213 # the specified constraint. Beware that most browsers cannot cope with very  
    1214 # large images. 
    1215  
    1216 MAX_DOT_GRAPH_HEIGHT   = 1024 
    1217  
    1218 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the  
    1219 # graphs generated by dot. A depth value of 3 means that only nodes reachable  
    1220 # from the root by following a path via at most 3 edges will be shown. Nodes  
    1221 # that lay further from the root node will be omitted. Note that setting this  
    1222 # option to 1 or 2 may greatly reduce the computation time needed for large  
    1223 # code bases. Also note that a graph may be further truncated if the graph's  
    1224 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH  
    1225 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),  
    1226 # the graph is not depth-constrained. 
    1227  
    1228 MAX_DOT_GRAPH_DEPTH    = 1000 
     1233# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of  
     1234# nodes that will be shown in the graph. If the number of nodes in a graph  
     1235# becomes larger than this value, doxygen will truncate the graph, which is  
     1236# visualized by representing a node as a red box. Note that doxygen will always  
     1237# show the root nodes and its direct children regardless of this setting. 
     1238 
     1239DOT_GRAPH_MAX_NODES    = 50 
    12291240 
    12301241# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent  

  • trunk/Doc/trac.doxy

    r402 r560  
    1414 
    1515 
     16INPUT = $(DOX_INPUT) 
     17 
    1618# Small set for testing... 
    17 # INPUT                  = ../Source/Base mainpage.dox 
     19# RECURSIVE              = YES 
     20# INPUT                  = ../Source/System mainpage.dox