]> SALOME platform Git repositories - modules/geom.git/commitdiff
Salome HOME
Fix issue 0019972: EDF 810 GEOM: doxygen documentation: to exclude 'geompyDC' from...
authorakl <akl@opencascade.com>
Mon, 17 Nov 2008 08:46:47 +0000 (08:46 +0000)
committerakl <akl@opencascade.com>
Mon, 17 Nov 2008 08:46:47 +0000 (08:46 +0000)
doc/salome/gui/GEOM/Makefile.am
doc/salome/gui/GEOM/doxyfile_py.in
doc/salome/gui/GEOM/input/geompy.doc
doc/salome/tui/Makefile.am
doc/salome/tui/doxyfile.in

index 6c746717c740c8f92a313d40d3a0f6095b4e22b2..320fde6ecd6b256e8bfa8647d2ca45eee9c33843 100755 (executable)
@@ -26,6 +26,12 @@ include $(top_srcdir)/adm_local/unix/make_common_starter.am
 EXTRA_DIST += images input static
 
 usr_docs: doxyfile_tui doxyfile_py 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 examples documentation" ;                              \
        echo "===========================================" ;                    \
@@ -35,18 +41,10 @@ usr_docs: doxyfile_tui doxyfile_py doxyfile
        echo "===========================================" ;                    \
        $(DOXYGEN) doxyfile_py ;                                                \
        echo "===========================================" ;                    \
-       echo "Replacing geompyDC by geompy" ;                                   \
-       echo "===========================================" ;                    \
-       files=`find geompy_doc -type f` ;                                       \
-       for filen in $${files} ; do                                             \
-         sed -e "s/\<geompyDC\>/geompy/g" -e "s/geompy\.geompy/geompy/g"       \
-             -e "s/geompy::geompy/geompy/g" $${filen} > $${filen}_ ;           \
-         mv -f $${filen}_ $${filen} ;                                          \
-       done ;                                                                  \
-       echo "===========================================" ;                    \
        echo "Generating GUI documentation" ;                                   \
        echo "===========================================" ;                    \
-       $(DOXYGEN) doxyfile ;
+       $(DOXYGEN) doxyfile ; \
+       rm -f $(top_builddir)/src/GEOM_SWIG/geompy.py
 
 docs: usr_docs
 
index 2dcd493414f2984991c2547278a5da9df73f68e7..a484a0cad248510759605049d25c31c176f0ae7f 100755 (executable)
@@ -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
index f35e6c16be919a6bcaebc878d5dcc076b4ea5b47..eb3198c5e70e1d370b7e500250ed3948da9701ca 100644 (file)
@@ -6,7 +6,7 @@
 <a href="geompy_doc/modules.html">structured documentation for geompy.py</a>,
 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".
 
 */
index dc1bf5976ae3fbce12d74230e3dfbba614d2009c..fdefb38628959f78cf5fae482a4bb08752d5efa8 100644 (file)
@@ -25,8 +25,17 @@ include $(top_srcdir)/adm_local/unix/make_common_starter.am
 EXTRA_DIST += images static
 
 dev_docs: doxyfile
-       echo "Running doxygen in directory: "`pwd`; \
-       $(DOXYGEN) $<;
+       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 "===========================================" ;                    \
+       $(DOXYGEN) doxyfile ;                                                   \
+       rm -f $(top_builddir)/src/GEOM_SWIG/geompy.py
 
 clean-local:
        -rm -fr GEOM doxygen.bak
index 4b69ca9adf7fd39294e066a2428573d4ec5a6204..bc7c9059516b568cfb1f1d21b38094bbc7f6c456 100755 (executable)
@@ -76,12 +76,14 @@ WARN_LOGFILE           =
 # configuration options related to the input files
 #---------------------------------------------------------------------------
 INPUT                  = @top_srcdir@/src \
+                        @top_builddir@/src/GEOM_SWIG/geompy.py \
                         @top_srcdir@/bin \
                         @top_srcdir@/idl \
                         @top_builddir@/bin
 FILE_PATTERNS          = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@
 RECURSIVE              = YES
-EXCLUDE                = 
+EXCLUDE                = @top_srcdir@/src/GEOM_SWIG/geompy.py \
+                        @top_srcdir@/src/GEOM_SWIG/geompyDC.py
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       = 
 EXAMPLE_PATH           =