Changeset cc86dd0 in git


Ignore:
Timestamp:
Jun 5, 2014, 6:58:59 PM (9 years ago)
Author:
Oleksandr Motsak <http://goo.gl/mcpzY>
Branches:
(u'spielwiese', '91fdef05f09f54b8d58d92a472e9c4a43aa4656f')
Children:
7e66d9f27a6aaca2a6aa50d429918ff75563c038
Parents:
be127e8573d50b2e989ea01124c123a1aac031b2
Message:
Better Doxygen settings and descriptions
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • dox/Doxyfile.in

    rbe127e rcc86dd0  
    2727# to put quotes around the project name if it contains spaces.
    2828
    29 PROJECT_NAME           = @PACKAGE_NAME@
     29PROJECT_NAME           =
    3030
    3131# The PROJECT_NUMBER tag can be used to enter a project or revision number.
    … …  
    3333# if some version control system is used.
    3434
    35 PROJECT_NUMBER         = @PACKAGE_VERSION@
     35PROJECT_NUMBER         =
    3636
    3737# Using the PROJECT_BRIEF tag one can provide an optional one line description
    … …  
    3939# a quick idea about the purpose of the project. Keep the description short.
    4040
    41 PROJECT_BRIEF          = CAS Singular
     41PROJECT_BRIEF          =
    4242
    4343# With the PROJECT_LOGO tag one can specify an logo or icon that is
    … …  
    5353# where doxygen was started. If left blank the current directory will be used.
    5454
    55 OUTPUT_DIRECTORY       =  @abs_builddir@
     55OUTPUT_DIRECTORY       = 
    5656
    5757# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
    … …  
    329329# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    330330
    331 EXTRACT_ALL            = NO
     331EXTRACT_ALL            = YES
    332332
    333333# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    334334# will be included in the documentation.
    335335
    336 EXTRACT_PRIVATE        = NO
     336EXTRACT_PRIVATE        = YES
    337337
    338338# If the EXTRACT_STATIC tag is set to YES all static members of a file
    339339# will be included in the documentation.
    340340
    341 EXTRACT_STATIC         = NO
     341EXTRACT_STATIC         = YES
    342342
    343343# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
    … …  
    352352# If set to NO (the default) only methods in the interface are included.
    353353
    354 EXTRACT_LOCAL_METHODS  = NO
     354EXTRACT_LOCAL_METHODS  = YES
    355355
    356356# If this flag is set to YES, the members of anonymous namespaces will be
    … …  
    396396# Set it to YES to include the internal documentation.
    397397
    398 INTERNAL_DOCS          = NO
     398INTERNAL_DOCS          = YES
    399399
    400400# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
    … …  
    410410# documentation. If set to YES the scope will be hidden.
    411411
    412 HIDE_SCOPE_NAMES       = NO
     412HIDE_SCOPE_NAMES       = YES
    413413
    414414# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
    … …  
    589589# automatically be disabled.
    590590
    591 WARN_IF_UNDOCUMENTED   = YES
     591WARN_IF_UNDOCUMENTED   = NO
    592592
    593593# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
    … …  
    619619# to stderr.
    620620
    621 WARN_LOGFILE           =
     621WARN_LOGFILE           = html_dox.log
    622622
    623623#---------------------------------------------------------------------------
    … …  
    633633@abs_top_srcdir@/resources/ \
    634634@abs_top_srcdir@/factory/ \
    635 @abs_top_srcdir@/factory/templates/ \
    636 @abs_top_srcdir@/factory/include/factory/ \
    637 @abs_top_srcdir@/factory/include/factory/templates/ \
    638635@abs_top_srcdir@/kernel/ \
    639 @abs_top_srcdir@/kernel/numeric/ \
    640 @abs_top_srcdir@/libpolys/misc/ \
    641 @abs_top_srcdir@/libpolys/reporter/ \
    642 @abs_top_srcdir@/libpolys/coeffs/ \
    643 @abs_top_srcdir@/libpolys/polys/ \
    644 @abs_top_srcdir@/libpolys/polys/ext_fields/ \
    645 @abs_top_srcdir@/libpolys/polys/monomials/ \
    646 @abs_top_srcdir@/libpolys/polys/nc/ \
    647 @abs_top_srcdir@/libpolys/polys/operations/ \
    648 @abs_top_srcdir@/libpolys/polys/templates/ \
    649 @abs_top_srcdir@/libpolys/tests/ \
    650 @abs_top_srcdir@/libpolys/tests/cxxtest/ \
    651 @abs_top_srcdir@/Singular/dyn_modules/bigintm/ \
    652 @abs_top_srcdir@/Singular/dyn_modules/syzextra/ \
     636@abs_top_srcdir@/libpolys/ \
    653637@abs_top_srcdir@/Singular/ \
    654 @abs_top_srcdir@/Singular/links/ \
    655 @abs_top_srcdir@/IntegerProgramming/ \
    656 @abs_top_srcdir@/gfanlib/ \
    657 @abs_top_srcdir@/Singular/dyn_modules/callgfanlib/ \
    658 @abs_top_srcdir@/Singular/dyn_modules/callpolymake/
    659 
     638@abs_top_srcdir@/main.dox
    660639
    661640
    … …  
    676655# *.f90 *.f *.for *.vhd *.vhdl
    677656
    678 FILE_PATTERNS          = *.h *.cc *.c *.cpp *.cxx *.inc *.l *.ll *.y *.yy *.dox
     657FILE_PATTERNS          = *.h *.cc *.c *.cpp *.cxx *.dox
    679658
    680659# The RECURSIVE tag can be used to turn specify whether or not subdirectories
    … …  
    682661# If left blank NO is used.
    683662
    684 RECURSIVE              = NO
     663RECURSIVE              = YES
    685664
    686665# The EXCLUDE tag can be used to specify files and/or directories that should
    … …  
    689668# Note that relative paths are relative to directory from which doxygen is run.
    690669
    691 EXCLUDE                =
     670EXCLUDE                = \
     671@abs_top_srcdir@/factory/examples \
     672@abs_top_srcdir@/kernel/old \
     673@abs_top_srcdir@/omalloc/Misc
     674
     675
    692676
    693677# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
    … …  
    695679# from the input.
    696680
    697 EXCLUDE_SYMLINKS       = NO
     681EXCLUDE_SYMLINKS       = YES
    698682
    699683# If the value of the INPUT tag contains directories, you can use the
    … …  
    703687# for example use the pattern */test/*
    704688
    705 EXCLUDE_PATTERNS       =
     689EXCLUDE_PATTERNS       = */test.cc
    706690
    707691# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
    … …  
    731715# Possible values are YES and NO. If left blank NO is used.
    732716
    733 EXAMPLE_RECURSIVE      = YES
     717EXAMPLE_RECURSIVE      = NO
    734718
    735719# The IMAGE_PATH tag can be used to specify one or more files or
    … …  
    784768# VERBATIM_HEADERS is set to NO.
    785769
    786 SOURCE_BROWSER         = NO
     770SOURCE_BROWSER         = YES
    787771
    788772# Setting the INLINE_SOURCES tag to YES will include the body
    789773# of functions and classes directly in the documentation.
    790774
    791 INLINE_SOURCES         = NO
     775INLINE_SOURCES         = YES
    792776
    793777# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
    … …  
    795779# fragments. Normal C and C++ comments will always remain visible.
    796780
    797 STRIP_CODE_COMMENTS    = YES
     781STRIP_CODE_COMMENTS    = NO
    798782
    799783# If the REFERENCED_BY_RELATION tag is set to YES
    … …  
    823807# will need version 4.8.6 or higher.
    824808
    825 USE_HTAGS              = NO
     809USE_HTAGS              = YES
    826810
    827811# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
    … …  
    11291113# Windows users are probably better off using the HTML help feature.
    11301114
    1131 GENERATE_TREEVIEW      = NO
     1115GENERATE_TREEVIEW      = YES
    11321116
    11331117# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
    11341118# and Class Hierarchy pages using a tree view instead of an ordered list.
    11351119
    1136 USE_INLINE_TREES       = NO
     1120USE_INLINE_TREES       = YES
    11371121
    11381122# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    … …  
    14851469# pointed to by INCLUDE_PATH will be searched when a #include is found.
    14861470
    1487 SEARCH_INCLUDES        = YES
     1471SEARCH_INCLUDES        = NO
    14881472
    14891473# The INCLUDE_PATH tag can be used to specify one or more directories that
    … …  
    14911475# the preprocessor.
    14921476
    1493 INCLUDE_PATH           =
     1477INCLUDE_PATH           = \
     1478@abs_top_builddir@/ @abs_top_builddir@/factory @abs_top_builddir@/libpolys
    14941479
    14951480# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
    … …  
    15081493# instead of the = operator.
    15091494
    1510 PREDEFINED             =
     1495PREDEFINED             = SINGULAR_DOXYGEN
    15111496
    15121497# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
    … …  
    15231508# semicolon, because these will confuse the parser if not removed.
    15241509
    1525 SKIP_FUNCTION_MACROS   = YES
     1510SKIP_FUNCTION_MACROS   = NO
    15261511
    15271512#---------------------------------------------------------------------------
    … …  
    15511536# a tag file that is based on the input files it reads.
    15521537
    1553 GENERATE_TAGFILE       =
     1538GENERATE_TAGFILE       = tags
    15541539
    15551540# If the ALLEXTERNALS tag is set to YES all external classes will be listed
    … …  
    16021587# have no effect if this option is set to NO (the default)
    16031588
    1604 HAVE_DOT               = NO
     1589HAVE_DOT               = YES
    16051590
    16061591# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
    … …  
    16371622# the CLASS_DIAGRAMS tag to NO.
    16381623
    1639 CLASS_GRAPH            = YES
     1624CLASS_GRAPH            = NO
    16401625
    16411626# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
    … …  
    16441629# class references variables) of the class with other documented classes.
    16451630
    1646 COLLABORATION_GRAPH    = YES
     1631COLLABORATION_GRAPH    = NO
    16471632
    16481633# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
    16491634# will generate a graph for groups, showing the direct groups dependencies
    16501635
    1651 GROUP_GRAPHS           = YES
     1636GROUP_GRAPHS           = NO
    16521637
    16531638# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
    … …  
    16671652# other documented files.
    16681653
    1669 INCLUDE_GRAPH          = YES
     1654INCLUDE_GRAPH          = NO
    16701655
    16711656# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
    … …  
    16741659# indirectly include this file.
    16751660
    1676 INCLUDED_BY_GRAPH      = YES
     1661INCLUDED_BY_GRAPH      = NO
    16771662
    16781663# If the CALL_GRAPH and HAVE_DOT options are set to YES then
    … …  
    16951680# will generate a graphical hierarchy of all classes instead of a textual one.
    16961681
    1697 GRAPHICAL_HIERARCHY    = YES
     1682GRAPHICAL_HIERARCHY    = NO
    16981683
    16991684# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
    … …  
    17301715# \dotfile command).
    17311716
    1732 DOTFILE_DIRS           =
     1717DOTFILE_DIRS           = @abs_top_srcdir@
     1718
    17331719
    17341720# The MSCFILE_DIRS tag can be used to specify one or more directories that
    … …  
    17561742# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    17571743
    1758 MAX_DOT_GRAPH_DEPTH    = 0
     1744MAX_DOT_GRAPH_DEPTH    = 3
    17591745
    17601746# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    … …  
    17711757# support this, this feature is disabled by default.
    17721758
    1773 DOT_MULTI_TARGETS      = NO
     1759DOT_MULTI_TARGETS      = YES
    17741760
    17751761# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
    … …  
    17771763# arrows in the dot generated graphs.
    17781764
    1779 GENERATE_LEGEND        = YES
     1765GENERATE_LEGEND        = NO
    17801766
    17811767# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will

  • factory/factory.dox

    rbe127e rcc86dd0  
    1 /*! \page factory_page Univariate polynomial factorization (factory)
     1/*! \page factory_page Multivariate polynomial factorization (factory)
    22 *
    33 * Factory is a C++ class library that implements a recursive representation

  • main.dox

    rbe127e rcc86dd0  
    1 /*! \mainpage Singular dev. manual
     1/*! \mainpage Singular kernel developers manual
    22
    3 <A HREF="http://www.singular.uni-kl.de">CAS Singular</A>
    4 
    5 Main source repository is on github.
     3This is a developers manual for the internals of <A
     4HREF="http://www.singular.uni-kl.de">Compute Algebra System
     5Singular</A>, with main <A
     6HREF="https://github.com/Singular/Sources/">source repository</A>.
    67For more manuals see <A HREF="https://github.com/Singular/Sources/wiki/">WIKI</A>.
    78
    8 Singular package diagram with dependencies is as follows:
    9 \dotfile Includes.dot Package diagram
    10 
    11 Introductory description of separate packages follows:
     9Separate top-level packages are as follows (also see the diagram below):
    1210- \subpage omalloc_page
    1311- \subpage resources_page
    … …  
    1715- \subpage singular_page
    1816
     17Dependencies between Singular packages are as follows:
     18\dotfile Includes.dot Package dependency diagram
     19
    1920 */
Note: See TracChangeset for help on using the changeset viewer.