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

Doc: Cosmetic fixes for doxyhen-generated doc

Browse Source 
The documentation generated with 'make WebDoc' is now a git repo at
https://github.com/FreeCAD/SourceDoc and can be read online via
https://freecad.github.io/SourceDoc/ - The page at
https://freecadweb.org/api now redirects to it.
This commit is contained in:
Yorik van Havre
2020-12-24 13:24:37 +01:00
parent 59c50bb684
commit 4cda00debe
4 changed files with 24 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/Doc/CMakeLists.txt
View File

@@ -65,7 +65,8 @@ if(DOXYGEN_FOUND)
${CMAKE_SOURCE_DIR}/src/Mod
${CMAKE_BINARY_DIR}/src/Mod
#${CMAKE_SOURCE_DIR}/src/Main #nothing to document there ATM...
${CMAKE_SOURCE_DIR}/src/Doc
${CMAKE_SOURCE_DIR}/src/Doc
${CMAKE_BINARY_DIR}/src/Doc
)
STRING(REGEX REPLACE ";" " " DOXYGEN_INPUT_LIST "${DOXYGEN_SOURCE_DIR}")

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

@@ -22,8 +22,6 @@
/**
\mainpage FreeCAD source documentation
This is the source documentation of <a href=https://www.freecadweb.org>FreeCAD</a>.
@@ -50,8 +48,6 @@
the source code documentation</a>. You can also browse through the <a href=https://github.com/FreeCAD/FreeCAD>source
code on github</a>.
\if DEV_DOCUMENTATION
\mainpage FreeCAD source documentation
@@ -78,7 +74,9 @@
\endif
<small>
@GIT_REVISION_INFO@
</small>
*/
/** \namespace std

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

@@ -16,11 +16,17 @@
</div>
</div>
<!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small>
$generatedby &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
</a> $doxygenversion
</small></address>
<address class="footer">
<small>
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/">
<img alt="Creative Commons Licence" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" />
</a> &#160;
$generatedby &#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
</a> $doxygenversion
</small>
</address>
<!--END !GENERATE_TREEVIEW-->
</body>
</html>

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

@@ -20,16 +20,21 @@
$mathjax
<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 href='//fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>-->
<link rel="stylesheet" href="$relpath^freecad.css">
<script type="text/javascript" src="$relpath^doxy-boot.js"></script>
<link rel="shortcut icon" href="favicon.ico">
<link rel="shortcut icon" href="https://freecadweb.org/images/favicon.ico">
</head>
<body>
<ul class="navbar" role="navigation">
<li>
<a href="https://freecadweb.org" title="FreeCAD">
<img src="https://freecadweb.org/images/freecad-logo.png">
</a>
</li>
<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>
<li><a href="$relpath^modules.html" title="Modules list">Modules</a></li>
<li><a href="$relpath^annotated.html" title="Annotated list">Classes</a></li>
</ul>
<div id="top" class="maincontents"><!-- do not remove this div, it is closed by doxygen! -->