Skip to content

Commit

Permalink
Doc: Further fixes to doxygen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yorikvanhavre committed Nov 24, 2016
1 parent bcb1534 commit 21dcfd4
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 19 deletions.
39 changes: 25 additions & 14 deletions src/Doc/BuildWebDoc.cfg.in
Expand Up @@ -337,7 +337,7 @@ EXTRACT_ANON_NSPACES = NO
# various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_MEMBERS = YES

# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
Expand Down Expand Up @@ -500,7 +500,7 @@ SHOW_FILES = NO
# This will remove the Namespaces entry from the Quick Index
# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES = YES
SHOW_NAMESPACES = NO

# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
Expand Down Expand Up @@ -647,7 +647,18 @@ EXCLUDE_PATTERNS =*.moc.* \
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test

EXCLUDE_SYMBOLS =
EXCLUDE_SYMBOLS = __init__ \
None \
__setstate__ \
__getstate__ \
_* \
boost \
Wm4 \
WildMagic4 \
KDL \
ap203* \
Py \
SIM

# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
Expand Down Expand Up @@ -857,7 +868,7 @@ HTML_COLORSTYLE_GAMMA = 80
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.

HTML_TIMESTAMP = YES
HTML_TIMESTAMP = NO

# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
Expand Down Expand Up @@ -1609,19 +1620,19 @@ DOT_FONTPATH =
# indirect inheritance relations. Setting this tag to YES will force the
# the CLASS_DIAGRAMS tag to NO.

CLASS_GRAPH = YES
CLASS_GRAPH = NO

# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.

COLLABORATION_GRAPH = YES
COLLABORATION_GRAPH = NO

# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for groups, showing the direct groups dependencies

GROUP_GRAPHS = YES
GROUP_GRAPHS = NO

# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
Expand All @@ -1632,21 +1643,21 @@ UML_LOOK = NO
# If set to YES, the inheritance and collaboration graphs will show the
# relations between templates and their instances.

TEMPLATE_RELATIONS = YES
TEMPLATE_RELATIONS = NO

# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
# tags are set to YES then doxygen will generate a graph for each documented
# file showing the direct and indirect include dependencies of the file with
# other documented files.

INCLUDE_GRAPH = YES
INCLUDE_GRAPH = NO

# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or
# indirectly include this file.

INCLUDED_BY_GRAPH = YES
INCLUDED_BY_GRAPH = NO

# If the CALL_GRAPH and HAVE_DOT options are set to YES then
# doxygen will generate a call dependency graph for every global function
Expand All @@ -1667,14 +1678,14 @@ CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one.

GRAPHICAL_HIERARCHY = YES
GRAPHICAL_HIERARCHY = NO

# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
# then doxygen will show the dependencies a directory has on other directories
# in a graphical way. The dependency relations are determined by the #include
# relations between the files in the directories.

DIRECTORY_GRAPH = YES
DIRECTORY_GRAPH = NO

# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are png, jpg, or gif
Expand Down Expand Up @@ -1727,13 +1738,13 @@ DOT_TRANSPARENT = NO

# support this, this feature is disabled by default.

DOT_MULTI_TARGETS = YES
DOT_MULTI_TARGETS = NO

# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
# generate a legend page explaining the meaning of the various boxes and
# arrows in the dot generated graphs.

GENERATE_LEGEND = YES
GENERATE_LEGEND = NO

# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
# remove the intermediate dot files that are used to generate
Expand Down
1 change: 1 addition & 0 deletions src/Doc/CMakeLists.txt
Expand Up @@ -43,6 +43,7 @@ if(DOXYGEN_FOUND)
set( DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Tools)
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/3rdParty/CxImage)
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/3rdParty/salomesmesh)
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Arch/Dice3DS)
# deprecated modules
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Assembly)
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Cam)
Expand Down
2 changes: 0 additions & 2 deletions src/Doc/templates/doxy-boot.js
Expand Up @@ -66,8 +66,6 @@ $( document ).ready(function() {
});

// source code github links
console.log("links:");
console.log($('li:contains("FreeCAD/src/")'));
$('li:contains("FreeCAD/src/")').each(function(){
var lk = '<a href="https://github.com/FreeCAD/FreeCAD/blob/master' + $(this).html().substr(7) + '">';
lk += $(this).html();
Expand Down
2 changes: 1 addition & 1 deletion src/Doc/templates/header.html
Expand Up @@ -46,7 +46,7 @@
<li><a href="modules.html" title="List of FreeCAD Modules">Modules</a></li>
<!-- <li><a href="namespaces.html" title="Namespaces">Namespaces</a></li> -->
<li><a href="annotated.html" title="List of namespaces and classes">Class list</a></li>
<li><a href="hierarchy.html" title="Tree view of classes">Class hierarchy</a></li>
<!-- <li><a href="hierarchy.html" title="Tree view of classes">Class hierarchy</a></li> -->
<li><a href="https://github.com/FreeCAD/FreeCAD" title="Browse the source code on GitHub">Source code</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
Expand Down
4 changes: 3 additions & 1 deletion src/Mod/Import/import.dox
@@ -1,3 +1,5 @@
/** \defgroup IMPORT Import
* \ingroup UTILITIES */
* \ingroup UTILITIES
* brief Utilities to import various file formats using OpenCasCade OCAF
*/

3 changes: 3 additions & 0 deletions src/Mod/Part/BOPTools/__init__.py
Expand Up @@ -27,6 +27,9 @@
BooleanFragments, Slice and XOR features of Part Workbench. Useful for other custom
BOP-like operations"""

## @package BOPTools
# \ingroup PART

__all__ = [
"GeneralFuseResult",
"JoinAPI",
Expand Down
2 changes: 1 addition & 1 deletion src/Mod/Ship/ship.dox
@@ -1,5 +1,5 @@
/** \defgroup SHIP Ship
* \ingroup UTILITIES
* \ingroup PYTHONWORKBENCHES
* \brief Tools towork with ship hulls
*/

0 comments on commit 21dcfd4

Please sign in to comment.