Doc: Further improvements to doxygen web output

FreeCAD · Nov 18, 2016 · 29d49cd · 29d49cd
1 parent 804dc1c
commit 29d49cd
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 7 deletions.
diff --git a/src/Doc/BuildWebDoc.cfg.in b/src/Doc/BuildWebDoc.cfg.in
@@ -105,7 +105,7 @@ INLINE_INHERITED_MEMB  = NO
 # path before files name in the file list and in the header files. If set
 # to NO the shortest path that makes the file name unique will be used.
 
-FULL_PATH_NAMES        = NO
+FULL_PATH_NAMES        = YES
 
 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
 # can be used to strip a user-defined part of the path. Stripping is
@@ -114,7 +114,7 @@ FULL_PATH_NAMES        = NO
 # If left blank the directory from which doxygen is run is used as the
 # path to strip.
 
-STRIP_FROM_PATH        =
+STRIP_FROM_PATH        = ../..
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
 # the path mentioned in the documentation of a class, which tells
@@ -442,25 +442,25 @@ SORT_BY_SCOPE_NAME     = YES
 # disable (NO) the todo list. This list is created by putting \todo
 # commands in the documentation.
 
-GENERATE_TODOLIST      = YES
+GENERATE_TODOLIST      = NO
 
 # The GENERATE_TESTLIST tag can be used to enable (YES) or
 # disable (NO) the test list. This list is created by putting \test
 # commands in the documentation.
 
-GENERATE_TESTLIST      = YES
+GENERATE_TESTLIST      = NO
 
 # The GENERATE_BUGLIST tag can be used to enable (YES) or
 # disable (NO) the bug list. This list is created by putting \bug
 # commands in the documentation.
 
-GENERATE_BUGLIST       = YES
+GENERATE_BUGLIST       = NO
 
 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
 # disable (NO) the deprecated list. This list is created by putting
 # \deprecated commands in the documentation.
 
-GENERATE_DEPRECATEDLIST= YES
+GENERATE_DEPRECATEDLIST= NO
 
 # The ENABLED_SECTIONS tag can be used to enable conditional
 # documentation sections, marked by \if sectionname ... \endif.
@@ -487,7 +487,7 @@ SHOW_USED_FILES        = YES
 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
 # in the documentation. The default is NO.
 
-SHOW_DIRECTORIES       = YES
+SHOW_DIRECTORIES       = NO
 
 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
 # This will remove the Files entry from the Quick Index and from the

diff --git a/src/Doc/templates/doxy-boot.js b/src/Doc/templates/doxy-boot.js
@@ -65,6 +65,16 @@ $( document ).ready(function() {
 		$(this).find('td > span.danger').parent().addClass('danger');
 	});
 
+    // 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();
+        lk += '</a>';
+        $(this).html(lk);
+    });
+
     $(".memdoc pre.fragment").contents().unwrap();
 
     if($('div.fragment.well div.ttc').length > 0)

diff --git a/src/Doc/templates/header.html b/src/Doc/templates/header.html
@@ -46,6 +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="https://github.com/FreeCAD/FreeCAD" title="Browse the source code on GitHub">Source code</a></li>
                     </ul>
                     <ul class="nav navbar-nav navbar-right">