From 6dd2eac181509db8378b1150349d105c89c31ce9 Mon Sep 17 00:00:00 2001 From: akl Date: Mon, 17 Nov 2008 08:37:46 +0000 Subject: [PATCH] Fix issue 0019972: EDF 810 GEOM: doxygen documentation: exclude 'geompyDC' from documentation and substitute it by 'geompy'. --- doc/salome/gui/GEOM/doxyfile_py.in | 4 ++-- doc/salome/gui/GEOM/input/geompy.doc | 2 +- doc/salome/gui/Makefile.am | 28 ++++++++-------------------- doc/salome/tui/GEOM/doxyfile.in | 4 +++- doc/salome/tui/GEOM/doxyfile_py.in | 4 +++- doc/salome/tui/Makefile.am | 26 ++++++++++++++++++++++++-- 6 files changed, 41 insertions(+), 27 deletions(-) diff --git a/doc/salome/gui/GEOM/doxyfile_py.in b/doc/salome/gui/GEOM/doxyfile_py.in index 26ae2c4db..97e691fdc 100755 --- a/doc/salome/gui/GEOM/doxyfile_py.in +++ b/doc/salome/gui/GEOM/doxyfile_py.in @@ -77,8 +77,8 @@ EXAMPLE_RECURSIVE = NO #--------------------------------------------------------------------------- #Input related options #--------------------------------------------------------------------------- -INPUT = @top_srcdir@/src/GEOM_SWIG -FILE_PATTERNS = geompyDC.py +INPUT = @top_builddir@/src/GEOM_SWIG +FILE_PATTERNS = geompy.py IMAGE_PATH = @srcdir@/images EXAMPLE_PATH = @top_srcdir@/src/GEOM_SWIG RECURSIVE = NO diff --git a/doc/salome/gui/GEOM/input/geompy.doc b/doc/salome/gui/GEOM/input/geompy.doc index f35e6c16b..eb3198c5e 100644 --- a/doc/salome/gui/GEOM/input/geompy.doc +++ b/doc/salome/gui/GEOM/input/geompy.doc @@ -6,7 +6,7 @@ structured documentation for geompy.py, where all package functionality is separated in groups by purpose. -\n Also you can find any function in the \ref geompyDC::geompyDC +\n Also you can find any function in the \ref geompy "linear documentation for geompy.py". */ diff --git a/doc/salome/gui/Makefile.am b/doc/salome/gui/Makefile.am index dc15d1047..7b9444bc7 100644 --- a/doc/salome/gui/Makefile.am +++ b/doc/salome/gui/Makefile.am @@ -27,31 +27,19 @@ EXTRA_DIST+=GEOM doxygen=@DOXYGEN@ -# Below command replaces "geompyDC" by "geompy" except cases -# "sgeompyDC", "1geompyDC" and "egeompyDC" (these sequences -# can be found in file names and must not be replaces): -# -# sed 's/\([^s1e]\)geompyDC\|^geompyDC/\1geompy/g' $${filen} > ./tmp; -# usr_docs: - cd ./GEOM; \ + echo "Replacing geompyDC by geompy" ; \ + sed -e "/class geompyDC/d" -e "s/^ *#/#/g" -e "s/^ *def /def /g" \ + -e "s/geompyDC/geompy/g" $(top_srcdir)/src/GEOM_SWIG/geompyDC.py > \ + $(top_builddir)/src/GEOM_SWIG/geompy.py ; \ + cd ./GEOM ; \ echo "Running doxygen in directory: "`pwd`; \ $(doxygen) ./doxyfile_tui; \ - echo "Processing geompyDC.py file: "; \ + echo "Processing geompy.py file: "; \ $(doxygen) ./doxyfile_py; \ - cd ./geompy_doc; \ - filesl=`find .`; \ - for filen in $${filesl}; do \ - sed 's/\([^s1e]\)geompyDC\|^geompyDC/\1geompy/g' $${filen} > ./tmp1; \ - sed 's/geompy\.geompy/geompy/g' ./tmp1 > ./tmp; \ - rm -f tmp1; \ - sed 's/geompy::geompy/geompy/g' ./tmp > ./tmp1; \ - rm -f tmp; \ - mv -f tmp1 $${filen}; \ - done; \ - cd ..; \ echo "Running doxygen in directory: "`pwd`; \ - $(doxygen) ./doxyfile; + $(doxygen) ./doxyfile; \ + rm -f $(top_builddir)/src/GEOM_SWIG/geompy.py docs: usr_docs diff --git a/doc/salome/tui/GEOM/doxyfile.in b/doc/salome/tui/GEOM/doxyfile.in index cba99e1ca..2573e187c 100755 --- a/doc/salome/tui/GEOM/doxyfile.in +++ b/doc/salome/tui/GEOM/doxyfile.in @@ -77,10 +77,12 @@ WARN_LOGFILE = log.txt # configuration options related to the input files #--------------------------------------------------------------------------- INPUT = ../../../share/salome/src \ + ../../../build/salome/src/GEOM_SWIG/geompy.py \ ../../../share/salome/idl FILE_PATTERNS = *.hxx *.cxx *.h *.c *.hh *.cc *.idl python_extension_must_be_here RECURSIVE = YES -EXCLUDE = +EXCLUDE = ../../../share/salome/src/GEOM_SWIG/geompy.py \ + ../../../share/salome/src/GEOM_SWIG/geompyDC.py EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = EXAMPLE_PATH = diff --git a/doc/salome/tui/GEOM/doxyfile_py.in b/doc/salome/tui/GEOM/doxyfile_py.in index 9d4d118db..b2ac16a74 100755 --- a/doc/salome/tui/GEOM/doxyfile_py.in +++ b/doc/salome/tui/GEOM/doxyfile_py.in @@ -77,11 +77,13 @@ WARN_LOGFILE = log.txt # configuration options related to the input files #--------------------------------------------------------------------------- INPUT = ../../../share/salome/src \ + ../../../build/salome/src/GEOM_SWIG/geompy.py \ ../../../share/salome/idl \ ../../../build/salome/bin FILE_PATTERNS = *.hxx *.cxx *.h *.c *.hh *.cc *.idl python_extension_must_be_here RECURSIVE = YES -EXCLUDE = +EXCLUDE = ../../../share/salome/src/GEOM_SWIG/geompy.py \ + ../../../share/salome/src/GEOM_SWIG/geompyDC.py EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = EXAMPLE_PATH = diff --git a/doc/salome/tui/Makefile.am b/doc/salome/tui/Makefile.am index b401ba210..a6cfe472b 100644 --- a/doc/salome/tui/Makefile.am +++ b/doc/salome/tui/Makefile.am @@ -24,7 +24,16 @@ include $(top_srcdir)/adm_local/unix/make_common_starter.am EXTRA_DIST+=GEOM -dev_docs: +dev_docs: doxyfile + echo "===========================================" ; \ + echo "Replacing geompyDC by geompy" ; \ + echo "===========================================" ; \ + sed -e "/class geompyDC/d" -e "s/^ *#/#/g" -e "s/^ *def /def /g" \ + -e "s/geompyDC/geompy/g" $(top_srcdir)/src/GEOM_SWIG/geompyDC.py > \ + $(top_builddir)/src/GEOM_SWIG/geompy.py ; \ + echo "===========================================" ; \ + echo "Generating TUI documentation" ; \ + echo "===========================================" ; \ cp -fr $(srcdir)/GEOM ./INPUT; \ cp -f ./GEOM/doxyfile ./INPUT; \ cd INPUT; \ @@ -49,7 +58,20 @@ dev_docs: $(DOXYGEN) ./doxyfile; \ cd ../; \ cp -fr $(srcdir)/GEOM/sources/ GEOM/ ; \ - rm -fr INPUT + rm -fr INPUT ; \ + rm -f $(top_builddir)/src/GEOM_SWIG/geompy.py + +clean-local: + -rm -fr GEOM doxygen.bak + +install-data-local: + if test -d GEOM; then \ + $(INSTALL) -d $(DESTDIR)$(docdir)/tui ; \ + cp -rp GEOM $(DESTDIR)$(docdir)/tui ; \ + fi; + +uninstall-local: + rm -rf $(DESTDIR)$(docdir)/tui/GEOM doctuidir=$(docdir)/tui/GEOM -- 2.39.2