[Olena-patches] milena r1612: Clean handle of generation of documentation

URL: https://svn.lrde.epita.fr/svn/oln/trunk/milena The generation of documentation is split in two part: user and internal. For the user documentation a directory user is created with the subdirectory html, which contains all namespace without internal and impl. Idem for internal documentation in the directory internal with all namespace. In milena/doc: make user-doc -> generation of user documentation. make internal-doc -> generation of internal documentation. make doc has the same enhancement of make internal-doc. ChangeLog: 2007-12-12 Guillaume Duhamel <guillaume.duhamel(a)lrde.epita.fr> Clean handle of generation of documentation. * doc/Makefile.am: New handle of generation of documentation, Doxyfile_user and Doxyfile_internal files are the template for Doxygen. They are generated from Doxygen.in * doc/Doxyfile_user.in: Remove (useless now). --- Doxyfile.in | 2 +- Makefile.am | 35 +++++++++++++++++++++++------------ 2 files changed, 24 insertions(+), 13 deletions(-) Index: trunk/milena/doc/Doxyfile_user.in (deleted) =================================================================== Index: trunk/milena/doc/Doxyfile.in =================================================================== --- trunk/milena/doc/Doxyfile.in (revision 1611) +++ trunk/milena/doc/Doxyfile.in (revision 1612) @@ -5,7 +5,7 @@ #--------------------------------------------------------------------------- PROJECT_NAME = "Milena (@PACKAGE_NAME@)" PROJECT_NUMBER = "@PACKAGE_VERSION@ @ID@" -OUTPUT_DIRECTORY = . +OUTPUT_DIRECTORY = ./internal/ CREATE_SUBDIRS = YES OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES Index: trunk/milena/doc/Makefile.am =================================================================== --- trunk/milena/doc/Makefile.am (revision 1611) +++ trunk/milena/doc/Makefile.am (revision 1612) @@ -10,10 +10,10 @@ html-local: Doxyfile - $(DOXYGEN) + $(DOXYGEN) $(srcdir)/Doxyfile_internal -html_user: Doxyfile_user - $(DOXYGEN) +html_user:: Doxyfile + $(DOXYGEN) $(srcdir)/Doxyfile_user edit = sed -e "s|@ID@|$$Id|" \ @@ -22,21 +22,32 @@ -e 's,@top_builddir\@,$(top_builddir),g' \ -e 's,@top_srcdir\@,$(top_srcdir),g' -EXTRA_DIST = Doxyfile.in \ - Doxyfile_user.in -CLEANFILES = Doxyfile +edit_user = sed -e 's,OUTPUT_DIRECTORY = ./internal/,OUTPUT_DIRECTORY = ./user/,g' \ + -e 's,EXTRACT_ALL = YES,EXTRACT_ALL = NO,g' \ + -e 's,EXTRACT_PRIVATE = YES,EXTRACT_PRIVATE = NO,g' \ + -e 's,EXTRACT_STATIC = YES,EXTRACT_STATIC = NO,g' \ + -e 's,EXTRACT_LOCAL_CLASSES = YES,EXTRACT_LOCAL_CLASSES = NO,g' \ + -e 's,HIDE_UNDOC_MEMBERS = NO,HIDE_UNDOC_MEMBERS = YES,g' \ + -e 's,HIDE_UNDOC_CLASSES = NO,HIDE_UNDOC_CLASSES = YES,g' \ + -e 's,HIDE_FRIEND_COMPOUNDS = NO,HIDE_FRIEND_COMPOUNDS = YES,g' \ + -e 's,HIDE_IN_BODY_DOCS = NO,HIDE_IN_BODY_DOCS = YES,g' \ + -e 's,INTERNAL_DOCS = YES,INTERNAL_DOCS = NO,g' \ + -e 's,PROJECT_NUMBER = \",PROJECT_NUMBER = \"User documentation ,g' + +EXTRA_DIST = Doxyfile.in + +CLEANFILES = Doxyfile_internal \ + Doxyfile_user + # Sed is used to generate Doxyfile from Doxyfile.in instead of # configure, because the former is way faster than the latter. # Moreover, this file is updated whenever ChangeLog is touched: using # sed instead of configure saves us a lot of time. Doxyfile: $(top_srcdir)/ChangeLog $(srcdir)/Doxyfile.in Id=`grep '^\$$Id' $(top_srcdir)/ChangeLog`; \ - $(edit) $(srcdir)/Doxyfile.in >Doxyfile - -Doxyfile_user: $(top_srcdir)/ChangeLog $(srcdir)/Doxyfile_user.in - Id=`grep '^\$$Id' $(top_srcdir)/ChangeLog`; \ - $(edit) $(srcdir)/Doxyfile_user.in >Doxyfile + $(edit) $(srcdir)/Doxyfile.in >Doxyfile_internal; \ + $(edit_user) $(srcdir)/Doxyfile_internal >Doxyfile_user clean-local: - rm -rf html latex user + rm -rf internal user