[DEV] better display of header for documentation page

doxy/default_doxy_file.dox

@@ -118,24 +118,24 @@ REPEAT_BRIEF           = YES
 # the entity):The $name class, The $name widget, The $name file, is, provides,
 # specifies, contains, represents, a, an and the.
 
-ABBREVIATE_BRIEF       = "The $name class" \
+#ABBREVIATE_BRIEF       = "The $name class" \
-                         "The $name widget" \
+#                         "The $name widget" \
-                         "The $name file" \
+#                         "The $name file" \
-                         is \
+#                         is \
-                         provides \
+#                         provides \
-                         specifies \
+#                         specifies \
-                         contains \
+#                         contains \
-                         represents \
+#                         represents \
-                         a \
+#                         a \
-                         an \
+#                         an \
-                         the
+#                         the
 
 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
 # doxygen will generate a detailed section even if there is only a brief
 # description.
 # The default value is: NO.
 
-ALWAYS_DETAILED_SEC    = NO
+ALWAYS_DETAILED_SEC    = YES
 
 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
 # inherited members of a class in the documentation of that class as if those

doxy/doxygen-bootstrapped/customdoxygen.css

@@ -1,6 +1,3 @@
-h1, .h1, h2, .h2, h3, .h3{
-    font-weight: 200 !important;
-}
 
 #navrow1, #navrow2, #navrow3, #navrow4, #navrow5{
     border-bottom: 1px solid #EEEEEE;
@@ -19,9 +16,27 @@ font-size: 1.15em !important;
 -------------------------------------------------- */
 html,
 body {
+    counter-reset: h1counter;
     height: 100%;
     /* The html and body elements cannot have any padding or margin. */
 }
+h1, .h1, h2, .h2, h3, .h3{
+    font-weight: bold !important;
+}
+h1:before {
+	content: counter(h1counter) ".\0000a0\0000a0";
+	counter-increment: h1counter;
+	counter-reset: h2counter;
+}
+h2:before {
+	content: counter(h1counter) "." counter(h2counter) ".\0000a0\0000a0";
+	counter-increment: h2counter;
+	counter-reset: h3counter;
+}
+h3:before {
+	content: counter(h1counter) "." counter(h2counter) "." counter(h3counter) ".\0000a0\0000a0";
+	counter-increment: h3counter;
+}
 
 /* Wrapper for page content to push down footer */
 #wrap {
@@ -342,8 +357,12 @@ span.SRScope {
 .page-header {
   margin: 20px 0px !important;
 }
-.page-header .title {
+.page-header {
-  display: inline-block;
+  #display: inline-block;
+}
+.title {
+  text-align: center;
+  color: orange;
 }
 .page-header .pull-right {
   margin-top: 0.3em;

doxy/module.py

@@ -46,6 +46,7 @@ class Module:
 		self.website_source = ""
 		self.path = []
 		self.data_path = []
+		self.sample_path = []
 		
 		# The module has been already build ...
 		self.isbuild = False
@@ -108,6 +109,15 @@ class Module:
 			else:
 				data += os.path.join(tools.get_current_path(self.origin_file), elem)
 			data += '"\n'
+		for elem in self.sample_path:
+			if len(elem) == 0:
+				continue
+			data += 'EXAMPLE_PATH += "'
+			if elem[0] == "/":
+				data += str(elem)
+			else:
+				data += os.path.join(tools.get_current_path(self.origin_file), elem)
+			data += '"\n'
 		if len(self.path) != 0:
 			data += 'INPUT = \n'
 			for elem in self.path:
@@ -164,6 +174,9 @@ class Module:
 	def add_path(self, list):
 		tools.list_append_to(self.path, list, True)
 	
+	def add_sample_path(self, list):
+		tools.list_append_to(self.sample_path, list, True)
+	
 	def add_data_path(self, list):
 		tools.list_append_to(self.data_path, list, True)
 	
@@ -196,6 +209,7 @@ class Module:
 		self.print_list('depends',self.depends)
 		self.print_list('define',self.define)
 		self.print_list('data_path',self.data_path)
+		self.print_list('sample_path',self.sample_path)
 		
 		return True