kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Cleanup in doxygen stuff

Browse Source
This commit is contained in:
Yorik van Havre
2019-07-15 23:20:52 -03:00
parent f2fdc0fde7
commit a6334a4bfd
26 changed files with 141 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/Doc/BuildWebDoc.cfg.in
View File

@@ -193,7 +193,7 @@ OPTIMIZE_OUTPUT_FOR_C = NO
# Java. For instance, namespaces will be presented as packages, qualified
# scopes will look different, etc.
OPTIMIZE_OUTPUT_JAVA = NO
OPTIMIZE_OUTPUT_JAVA = YES
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for

4
src/Doc/CMakeLists.txt
View File

@@ -65,7 +65,7 @@ if(DOXYGEN_FOUND)
${CMAKE_BINARY_DIR}/src/Gui
${CMAKE_SOURCE_DIR}/src/Mod
${CMAKE_BINARY_DIR}/src/Mod
${CMAKE_SOURCE_DIR}/src/Main
#${CMAKE_SOURCE_DIR}/src/Main #nothing to document there ATM...
${CMAKE_SOURCE_DIR}/src/Doc
)
STRING(REGEX REPLACE ";" " " DOXYGEN_INPUT_LIST "${DOXYGEN_SOURCE_DIR}")
@@ -75,8 +75,6 @@ if(DOXYGEN_FOUND)
# src/3rdParty/CxImage : Windows thumbnailer
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)
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Doc/sphinx)
# deprecated modules
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Assembly)

4
src/Doc/mainpage.dox.in
View File

@@ -22,7 +22,7 @@
/**
\if WEB_DOCUMENTATION
\mainpage FreeCAD source documentation
@@ -50,7 +50,7 @@
the source code documentation</a>. You can also browse through the <a href=https://github.com/FreeCAD/FreeCAD>source
code on github</a>.
\endif
\if DEV_DOCUMENTATION

5
src/Doc/primary-groups.dox
View File

@@ -1,9 +1,10 @@
/** \defgroup CORE Core
This is the core functionality of FreeCAD.
These are the core components of FreeCAD.
It groups the Base classes, and the main components of FreeCAD core,
spread over their App and Gui sides. Core components are programmed in
C++ but provide a broad Python API.
C++ but provide a broad Python API too. Most of FreeCAD functionality,
however, is defined in Workbenches.
*/
/** \defgroup WORKBENCHES Workbenches

38
src/Doc/templates/footer.html
View File

@@ -22,43 +22,5 @@ $generatedby &#160;<a href="http://www.doxygen.org/index.html">
</a> $doxygenversion
</small></address>
<!--END !GENERATE_TREEVIEW-->
<footer>
<div class="container text-muted">
<div class="row">
<div class="col-md-3">
Community
<ul>
<li><a href="https://github.com/FreeCAD/FreeCAD">Github</a></li>
<li><a href="https://www.facebook.com/FreeCAD">Facebook</a></li>
<li><a href="https://plus.google.com/u/0/communities/103183769032333474646">Google+</a></li>
</ul>
</div>
<div class="col-md-3">
Learn
<ul>
<li><a href="https://www.freecadweb.org/wiki/Tutorials">Tutorials</a></li>
<li><a href="https://www.youtube.com/results?search_query=freecad">Youtube videos</a></li>
<li><a href="http://area51.stackexchange.com/proposals/88434/freecad">Stack Exchange</a></li>
</ul>
</div>
<div class="col-md-3">
Help the project
<ul>
<li><a href="https://www.freecadweb.org/wiki/Help_FreeCAD">How can I help?</a></li>
<li><a href="https://www.freecadweb.org/wiki/Donate"><i class="fa fa-heart"></i> Donate!</a></li>
<li><a href="https://crowdin.com/project/freecad">Translate</a></li>
</ul>
</div>
<div class="col-md-3">
Code
<ul>
<li><a href="https://www.freecadweb.org/wiki/Compiling">Building from source</a></li>
<li><a href="https://www.freecadweb.org/api/">C++ & Python API</a></li>
<li><a href="https://www.freecadweb.org/wiki/Licence">License information</a></li>
</ul>
</div>
</div>
</div>
</footer>
</body>
</html>

59
src/Doc/templates/header.html
View File

@@ -9,7 +9,7 @@
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen $doxygenversion"/>
<script type="text/javascript" src="//www.freecadweb.org/js/jquery-2.1.4.min.js"></script>
<script type="text/javascript" src="$relpath^jquery.js"></script>
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
@@ -21,59 +21,16 @@
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
<link href='//fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="//www.freecadweb.org/css/bootstrap-3.3.5.min.css">
<link rel="stylesheet" href="//www.freecadweb.org/css/font-awesome-4.4.0.min.css">
<link rel="stylesheet" href="//www.freecadweb.org/css/freecad.css">
<script src="//www.freecadweb.org/js/bootstrap-3.3.5.min.js"></script>
<link rel="stylesheet" href="$relpath^freecad.css">
<script type="text/javascript" src="$relpath^doxy-boot.js"></script>
<link rel="shortcut icon" href="//www.freecadweb.org/images/favicon.ico">
<link rel="shortcut icon" href="favicon.ico">
</head>
<body>
<div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button class="navbar-toggle collapsed" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only"><?php echo _('Toggle navigation'); ?></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/"><img alt="FreeCAD-logo" src="//www.freecadweb.org/images/logo.png"/> FreeCAD</a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="/api/index.html" title="Welcome page">API Home</a></li>
<li><a href="/api/modules.html" title="List of FreeCAD Modules">Modules</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Contents <span class="caret"></span></a>
<ul class="dropdown-menu">
<li><a href="/api/annotated.html" title="Annotated list">Annotated list</a></li>
<li><a href="/api/namespaces.html" title="Namespaces">Namespaces</a></li>
<li><a href="/api/classes.html" title="Classes">Classes</a></li>
<li><a href="/api/functions.html" title="Functions">Functions</a></li>
<li><a href="/api/hierarchy.html" title="Tree view of classes">Class hierarchy</a></li>
<li><a href="/api/page.html" title="Related pages">Related pages</a></li>
</ul>
</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">
<form class="navbar-search navbar-form" action="//duckduckgo.com/" id="searchform" role="search" method="get">
<div>
<input type="hidden" name="sites" value="freecadweb.org"/>
<input type="text" name="q" class="form-control" placeholder="Search" title="Search FreeCAD documentation, forum and bugs" maxlength=300>
<input type="submit" name="title" value="DuckDuckGo Search" style="width: 0; visibility: hidden;">
</div>
</form>
</ul>
<ul class="nav navbar-nav navbar-right">
<li><a title="Forum" href="http://forum.freecadweb.org"><i class="fa fa-commenting"></i></a></li>
<li><a title="Wiki" href="/wiki/"><i class="fa fa-book"></i></a></li>
<li><a title="Tracker" href="/tracker/"><i class="fa fa-bug"></i></a></li>
</ul>
</div><!--/.nav-collapse -->
</div>
</div>
<ul class="navbar" role="navigation">
<li><a href="$relpath^index.html" title="Index">Index</a></li>
<li><a href="$relpath^modules.html" title="Modules list">Modules Hierarchy</a></li>
<li><a href="$relpath^annotated.html" title="Annotated list">Alphabetical list</a></li>
</ul>
<div id="top" class="maincontents"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">