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,6 +80,11 @@ SRCDIRS		+= usr
80 80
 NON_AUTO_SRCS	:=
81 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 90
 # Default build target: build the most common targets and print out a

+ 18
- 5
src/Makefile.housekeeping View File

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

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

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

+ 21
- 24
src/doxygen.cfg View File

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

Loading…
Cancel
Save