Upgrade doxygen configuration files to the latest version.

[pub/lufa.git] / Maintenance / makefile

diff --git a/Maintenance/makefile b/Maintenance/makefile
index 65e9ef2..4d172eb 100644 (file)
--- a/Maintenance/makefile
+++ b/Maintenance/makefile
@@ -1,6 +1,6 @@
 #
 #             LUFA Library
-#     Copyright (C) Dean Camera, 2013.
+#     Copyright (C) Dean Camera, 2021.
 #
 #  dean [at] fourwalledcubicle [dot] com
 #           www.lufa-lib.org
@@ -14,24 +14,28 @@ LUFA_ROOT := ../
 
 all:
 
-# Update all Doxygen configuration files to the latest Doxygen version - force Markdown support to be disabled
+# Generate a header containing all library functions
+function-list:
+       $(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT))/LUFA doxygen DOXYGEN_OVERRIDE_PARAMS="GENERATE_HTML=no GENERATE_XML=yes"
+       @xsltproc $(patsubst %/,%,$(LUFA_ROOT))/LUFA/Documentation/xml/combine.xslt $(patsubst %/,%,$(LUFA_ROOT))/LUFA/Documentation/xml/index.xml > temp.xml
+       @xsltproc lufa_functionlist_transform.xslt temp.xml > function_list.h
+       @sort function_list.h | uniq > function_list_unique.h
+       @rm temp.xml
+
+# Update all Doxygen configuration files to the latest Doxygen version
 upgrade-doxygen:
-       @echo Upgrading Doxygen.conf files...
-       @for doxygen_conf in `find $(LUFA_ROOT) -name Doxygen.conf`; do                                       \
-         doxygen -u $$doxygen_conf;                                                                          \
-         sed "s/MARKDOWN_SUPPORT *= *YES/MARKDOWN_SUPPORT       = NO/1" $$doxygen_conf > $$doxygen_conf.new; \
-         sed "s/DISABLE_INDEX *= *NO/DISABLE_INDEX       = YES/1" $$doxygen_conf.new > $$doxygen_conf.new2;  \
-         mv -u $$doxygen_conf.new2 $$doxygen_conf;                                                           \
-         rm $$doxygen_conf.new;                                                                              \
+       @echo Upgrading Doxygen files...
+       @for doxygen_conf in `find $(LUFA_ROOT) -name doxyfile`; do \
+         doxygen -u $$doxygen_conf;                                \
        done;
        @echo Doxygen configuration update complete.
 
 # Make all possible bootloaders for all targets and configurations as set by the BootloaderTest build test
-# and store them in a seperate directory called "Bootloaders"
-make_bootloaders:
+# and store them in a separate directory called "Bootloaders"
+bootloaders:
        @echo "build_bootloaders:" > BuildMakefile
        @printf "\t-mkdir Bootloaders 2>/dev/null\n\n" >> BuildMakefile
-       
+
        @while read line;                                         \
         do                                                       \
           build_cfg=`echo $$line | grep -v "#" | sed 's/ //g'`;  \
@@ -61,26 +65,17 @@ make_bootloaders:
         rm -f BuildMakefile
 
 # Check the working branch documentation, ensure no placeholder values
-check-documentation-placeholders:
+check-release:
        @echo Checking for release suitability...
-       @if ( grep "XXXXXX" $(patsubst %/,%,$(LUFA_ROOT))/LUFA/DoxygenPages/*.txt > /dev/null ;); then \
-         echo "  ERROR: Doxygen documentation has not been updated for release!";    \
+       @if ( grep " LUFA_VERSION_RELEASE_TYPE " $(patsubst %/,%,$(LUFA_ROOT))/LUFA/Version.h | grep "LUFA_VERSION_RELEASE_TYPE_DEVELOPMENT" > /dev/null ;); then          \
+         echo "  ERROR: Version header has not been updated for release!";           \
          exit 1;                                                                     \
        fi;
-       @if ( grep "000000" $(patsubst %/,%,$(LUFA_ROOT))/LUFA/Version.h > /dev/null ;); then          \
-         echo "  ERROR: Version header has not been updated for release!";           \
+       @if ( grep "XXXXXX" $(patsubst %/,%,$(LUFA_ROOT))/LUFA/DoxygenPages/*.txt > /dev/null ;); then \
+         echo "  ERROR: Doxygen documentation has not been updated for release!";    \
          exit 1;                                                                     \
        fi;
-       @echo Done.
-
-# Validate the working branch - compile all documentation, demos/projects/examples and run build tests
-validate-branch:
-       $(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT)) doxygen
-       $(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT)) all DEBUG_LEVEL=0
-       $(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT))/BuildTests all
-
-# Validate the working branch for general release, check for placeholder documentation then build and test everything
-validate-release: check-documentation-placeholders validate-branch
 
+       @echo Done.
 
-.PHONY: all upgrade-doxygen make-as4-projects make_bootloaders check-documentation-placeholders validate-branch
\ No newline at end of file
+.PHONY: all function-list upgrade-doxygen bootloaders check-release