Browse Source

[doc] Expand scope of doxygen-generated documentation

tags/v0.9.8
Michael Brown 15 years ago
parent
commit
b3db99a38d
4 changed files with 45 additions and 30 deletions
  1. 5
    0
      src/Makefile
  2. 18
    5
      src/Makefile.housekeeping
  3. 1
    1
      src/arch/x86/Makefile
  4. 21
    24
      src/doxygen.cfg

+ 5
- 0
src/Makefile View File

80
 NON_AUTO_SRCS	:=
80
 NON_AUTO_SRCS	:=
81
 NON_AUTO_SRCS	+= drivers/net/prism2.c
81
 NON_AUTO_SRCS	+= drivers/net/prism2.c
82
 
82
 
83
+# INCDIRS lists the include path
84
+#
85
+INCDIRS		:=
86
+INCDIRS		+= include .
87
+
83
 ###############################################################################
88
 ###############################################################################
84
 #
89
 #
85
 # Default build target: build the most common targets and print out a
90
 # Default build target: build the most common targets and print out a

+ 18
- 5
src/Makefile.housekeeping View File

292
 include arch/$(ARCH)/Makefile
292
 include arch/$(ARCH)/Makefile
293
 endif
293
 endif
294
 
294
 
295
+# Include architecture-specific include path
296
+ifdef ARCH
297
+INCDIRS		+= arch/$(ARCH)/include
298
+endif
299
+
295
 ###############################################################################
300
 ###############################################################################
296
 #
301
 #
297
 # Source file handling
302
 # Source file handling
320
 
325
 
321
 ifdef BIN
326
 ifdef BIN
322
 
327
 
328
+# INCDIRS lists the include path
329
+incdirs :
330
+	@$(ECHO) $(INCDIRS)
331
+
323
 # Common flags
332
 # Common flags
324
 #
333
 #
325
-CFLAGS		+= -I include -I arch/$(ARCH)/include -I .
334
+CFLAGS		+= $(foreach INC,$(INCDIRS),-I$(INC))
326
 CFLAGS		+= -Os
335
 CFLAGS		+= -Os
327
 CFLAGS		+= -g
336
 CFLAGS		+= -g
328
 ifeq ($(CCTYPE),gcc)
337
 ifeq ($(CCTYPE),gcc)
953
 ifdef BIN
962
 ifdef BIN
954
 
963
 
955
 $(BIN)/doxygen.cfg : doxygen.cfg $(MAKEDEPS)
964
 $(BIN)/doxygen.cfg : doxygen.cfg $(MAKEDEPS)
956
-	$(PERL) -pe 's{\@SRCDIRS\@}{$(SRCDIRS)}; ' \
965
+	$(Q)$(PERL) -pe 's{\@SRCDIRS\@}{$(SRCDIRS)}; ' \
966
+		-e  's{\@INCDIRS\@}{$(filter-out .,$(INCDIRS))}; ' \
957
 		-e  's{\@BIN\@}{$(BIN)}; ' \
967
 		-e  's{\@BIN\@}{$(BIN)}; ' \
958
 		-e  's{\@ARCH\@}{$(ARCH)}; ' \
968
 		-e  's{\@ARCH\@}{$(ARCH)}; ' \
959
 		$< > $@
969
 		$< > $@
960
 
970
 
961
 $(BIN)/doc : $(BIN)/doxygen.cfg
971
 $(BIN)/doc : $(BIN)/doxygen.cfg
962
-	$(DOXYGEN) $<
972
+	$(Q)$(DOXYGEN) $<
963
 
973
 
964
 .PHONY : $(BIN)/doc
974
 .PHONY : $(BIN)/doc
965
 
975
 
966
-VERYCLEANUP	+= $(BIN)/doc
967
-
968
 doc : $(BIN)/doc
976
 doc : $(BIN)/doc
969
 
977
 
978
+doc-clean :
979
+	$(Q)$(RM) -r $(BIN)/doc
980
+
981
+VERYCLEANUP	+= $(BIN)/doc
982
+
970
 docview :
983
 docview :
971
 	@[ -f $(BIN)/doc/html/index.html ] || $(MAKE) $(BIN)/doc
984
 	@[ -f $(BIN)/doc/html/index.html ] || $(MAKE) $(BIN)/doc
972
 	@if [ -n "$$BROWSER" ] ; then \
985
 	@if [ -n "$$BROWSER" ] ; then \

+ 1
- 1
src/arch/x86/Makefile View File

1
 # Include common x86 headers
1
 # Include common x86 headers
2
 #
2
 #
3
-CFLAGS		+= -Iarch/x86/include
3
+INCDIRS		+= arch/x86/include
4
 
4
 
5
 # x86-specific directories containing source files
5
 # x86-specific directories containing source files
6
 #
6
 #

+ 21
- 24
src/doxygen.cfg View File

25
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
25
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
26
 # by quotes) that should identify the project.
26
 # by quotes) that should identify the project.
27
 
27
 
28
-PROJECT_NAME           = Etherboot
28
+PROJECT_NAME           = gPXE
29
 
29
 
30
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
30
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
31
 # This could be handy for archiving the generated documentation or 
31
 # This could be handy for archiving the generated documentation or 
92
 # Doxygen will generate a detailed section even if there is only a brief 
92
 # Doxygen will generate a detailed section even if there is only a brief 
93
 # description.
93
 # description.
94
 
94
 
95
-ALWAYS_DETAILED_SEC    = NO
95
+ALWAYS_DETAILED_SEC    = YES
96
 
96
 
97
 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
97
 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
98
 # inherited members of a class in the documentation of that class as if those 
98
 # inherited members of a class in the documentation of that class as if those 
105
 # path before files name in the file list and in the header files. If set 
105
 # path before files name in the file list and in the header files. If set 
106
 # to NO the shortest path that makes the file name unique will be used.
106
 # to NO the shortest path that makes the file name unique will be used.
107
 
107
 
108
-FULL_PATH_NAMES        = NO
108
+FULL_PATH_NAMES        = YES
109
 
109
 
110
 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
110
 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
111
 # can be used to strip a user-defined part of the path. Stripping is 
111
 # can be used to strip a user-defined part of the path. Stripping is 
236
 # setting a simple type. If this is not the case, or you want to show the 
236
 # setting a simple type. If this is not the case, or you want to show the 
237
 # methods anyway, you should set this option to NO.
237
 # methods anyway, you should set this option to NO.
238
 
238
 
239
-IDL_PROPERTY_SUPPORT   = YES
239
+IDL_PROPERTY_SUPPORT   = NO
240
 
240
 
241
 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
241
 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
242
 # tag is set to YES, then doxygen will reuse the documentation of the first 
242
 # tag is set to YES, then doxygen will reuse the documentation of the first 
243
 # member in the group (if any) for the other members of the group. By default 
243
 # member in the group (if any) for the other members of the group. By default 
244
 # all members of a group must be documented explicitly.
244
 # all members of a group must be documented explicitly.
245
 
245
 
246
-DISTRIBUTE_GROUP_DOC   = NO
246
+DISTRIBUTE_GROUP_DOC   = YES
247
 
247
 
248
 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
248
 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
249
 # the same type (for instance a group of public functions) to be put as a 
249
 # the same type (for instance a group of public functions) to be put as a 
288
 # Private class members and static file members will be hidden unless 
288
 # Private class members and static file members will be hidden unless 
289
 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
289
 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
290
 
290
 
291
-EXTRACT_ALL            = NO
291
+EXTRACT_ALL            = YES
292
 
292
 
293
 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
293
 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
294
 # will be included in the documentation.
294
 # will be included in the documentation.
375
 # will put a list of the files that are included by a file in the documentation 
375
 # will put a list of the files that are included by a file in the documentation 
376
 # of that file.
376
 # of that file.
377
 
377
 
378
-SHOW_INCLUDE_FILES     = NO
378
+SHOW_INCLUDE_FILES     = YES
379
 
379
 
380
 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
380
 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
381
 # is inserted in the documentation for inline members.
381
 # is inserted in the documentation for inline members.
528
 # wrong or incomplete parameter documentation, but not about the absence of 
528
 # wrong or incomplete parameter documentation, but not about the absence of 
529
 # documentation.
529
 # documentation.
530
 
530
 
531
-WARN_NO_PARAMDOC       = NO
531
+WARN_NO_PARAMDOC       = YES
532
 
532
 
533
 # The WARN_FORMAT tag determines the format of the warning messages that 
533
 # The WARN_FORMAT tag determines the format of the warning messages that 
534
 # doxygen can produce. The string should contain the $file, $line, and $text 
534
 # doxygen can produce. The string should contain the $file, $line, and $text 
555
 # with spaces.
555
 # with spaces.
556
 
556
 
557
 INPUT                  = @SRCDIRS@ \
557
 INPUT                  = @SRCDIRS@ \
558
-                         include \
559
-                         include/gpxe \
560
-                         arch/@ARCH@/include \
558
+                         @INCDIRS@ \
559
+                         config \
561
                          doc
560
                          doc
562
 
561
 
563
 # This tag can be used to specify the character encoding of the source files 
562
 # This tag can be used to specify the character encoding of the source files 
577
 
576
 
578
 FILE_PATTERNS          = *.c \
577
 FILE_PATTERNS          = *.c \
579
                          *.h \
578
                          *.h \
580
-                         *.S \
581
                          *.dox
579
                          *.dox
582
 
580
 
583
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
581
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
584
 # should be searched for input files as well. Possible values are YES and NO. 
582
 # should be searched for input files as well. Possible values are YES and NO. 
585
 # If left blank NO is used.
583
 # If left blank NO is used.
586
 
584
 
587
-RECURSIVE              = NO
585
+RECURSIVE              = YES
588
 
586
 
589
 # The EXCLUDE tag can be used to specify files and/or directories that should 
587
 # The EXCLUDE tag can be used to specify files and/or directories that should 
590
 # excluded from the INPUT source files. This way you can easily exclude a 
588
 # excluded from the INPUT source files. This way you can easily exclude a 
679
 # Setting the INLINE_SOURCES tag to YES will include the body 
677
 # Setting the INLINE_SOURCES tag to YES will include the body 
680
 # of functions and classes directly in the documentation.
678
 # of functions and classes directly in the documentation.
681
 
679
 
682
-INLINE_SOURCES         = NO
680
+INLINE_SOURCES         = YES
683
 
681
 
684
 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
682
 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
685
 # doxygen to hide any special comment blocks from generated source code 
683
 # doxygen to hide any special comment blocks from generated source code 
697
 # then for each documented function all documented entities 
695
 # then for each documented function all documented entities 
698
 # called/used by that function will be listed.
696
 # called/used by that function will be listed.
699
 
697
 
700
-REFERENCES_RELATION    = NO
698
+REFERENCES_RELATION    = YES
701
 
699
 
702
 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
700
 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
703
 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
701
 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
797
 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
795
 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
798
 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
796
 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
799
 
797
 
800
-HTML_DYNAMIC_SECTIONS  = NO
798
+HTML_DYNAMIC_SECTIONS  = YES
801
 
799
 
802
 # If the GENERATE_DOCSET tag is set to YES, additional index files 
800
 # If the GENERATE_DOCSET tag is set to YES, additional index files 
803
 # will be generated that can be used as input for Apple's Xcode 3 
801
 # will be generated that can be used as input for Apple's Xcode 3 
867
 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
865
 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
868
 # to the contents of the HTML help documentation and to the tree view.
866
 # to the contents of the HTML help documentation and to the tree view.
869
 
867
 
870
-TOC_EXPAND             = NO
868
+TOC_EXPAND             = YES
871
 
869
 
872
 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 
870
 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 
873
 # are set, an additional index file will be generated that can be used as input for 
871
 # are set, an additional index file will be generated that can be used as input for 
927
 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
925
 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
928
 # respectively.
926
 # respectively.
929
 
927
 
930
-GENERATE_TREEVIEW      = NO
928
+GENERATE_TREEVIEW      = NONE
931
 
929
 
932
 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
930
 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
933
 # used to set the initial width (in pixels) of the frame in which the tree 
931
 # used to set the initial width (in pixels) of the frame in which the tree 
950
 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
948
 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
951
 # generate Latex output.
949
 # generate Latex output.
952
 
950
 
953
-GENERATE_LATEX         = YES
951
+GENERATE_LATEX         = NO
954
 
952
 
955
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
953
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
956
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
954
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1068
 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
1066
 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
1069
 # generate man pages
1067
 # generate man pages
1070
 
1068
 
1071
-GENERATE_MAN           = YES
1069
+GENERATE_MAN           = NO
1072
 
1070
 
1073
 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
1071
 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
1074
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1072
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1201
 # contain include files that are not input files but should be processed by 
1199
 # contain include files that are not input files but should be processed by 
1202
 # the preprocessor.
1200
 # the preprocessor.
1203
 
1201
 
1204
-INCLUDE_PATH           = include \
1205
-                         arch/@ARCH@/include
1202
+INCLUDE_PATH           = @INCDIRS@
1206
 
1203
 
1207
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1204
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1208
 # patterns (like *.h and *.hpp) to filter out the header-files in the 
1205
 # patterns (like *.h and *.hpp) to filter out the header-files in the 
1297
 # fallback. It is recommended to install and use dot, since it yields more 
1294
 # fallback. It is recommended to install and use dot, since it yields more 
1298
 # powerful graphs.
1295
 # powerful graphs.
1299
 
1296
 
1300
-CLASS_DIAGRAMS         = YES
1297
+CLASS_DIAGRAMS         = NO
1301
 
1298
 
1302
 # You can define message sequence charts within doxygen comments using the \msc 
1299
 # You can define message sequence charts within doxygen comments using the \msc 
1303
 # command. Doxygen will then run the mscgen tool (see 
1300
 # command. Doxygen will then run the mscgen tool (see 
1312
 # inheritance and usage relations if the target is undocumented 
1309
 # inheritance and usage relations if the target is undocumented 
1313
 # or is not a class.
1310
 # or is not a class.
1314
 
1311
 
1315
-HIDE_UNDOC_RELATIONS   = YES
1312
+HIDE_UNDOC_RELATIONS   = NO
1316
 
1313
 
1317
 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1314
 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1318
 # available from the path. This tool is part of Graphviz, a graph visualization 
1315
 # available from the path. This tool is part of Graphviz, a graph visualization 

Loading…
Cancel
Save