diff options
author | VirtualTam <virtualtam@flibidi.net> | 2015-07-13 17:53:36 +0200 |
---|---|---|
committer | VirtualTam <virtualtam@flibidi.net> | 2015-11-22 20:35:00 +0100 |
commit | 05af6f53256056eacb3813aff8aa606e83365f61 (patch) | |
tree | 09a65983f449dd83358456a46837165bf36cbdc7 /Makefile | |
parent | 9b87c274396c20aa006b5988141fe74c48f042ce (diff) | |
download | Shaarli-05af6f53256056eacb3813aff8aa606e83365f61.tar.gz Shaarli-05af6f53256056eacb3813aff8aa606e83365f61.tar.zst Shaarli-05af6f53256056eacb3813aff8aa606e83365f61.zip |
Add a target to generate Doxygen documentation
Relates to #95
Customizations for PHP/Shaarli:
- add project information
- index PHP files
- index global functions
- exclude directories
Usage
$ make doxygen
$ firefox doxygen/index.html &
Notes
- classes can be found under "Data Structures"
- global functions can be found under "Files > Globals > Functions"
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'Makefile')
-rw-r--r-- | Makefile | 5 |
1 files changed, 5 insertions, 0 deletions
@@ -120,6 +120,11 @@ test: | |||
120 | clean: | 120 | clean: |
121 | @git clean -df | 121 | @git clean -df |
122 | 122 | ||
123 | ### generate Doxygen documentation | ||
124 | doxygen: clean | ||
125 | @rm -rf doxygen | ||
126 | @( cat Doxyfile ; echo "PROJECT_NUMBER=`git describe`" ) | doxygen - | ||
127 | |||
123 | ### update the local copy of the documentation | 128 | ### update the local copy of the documentation |
124 | doc: clean | 129 | doc: clean |
125 | @rm -rf doc | 130 | @rm -rf doc |