From: akl <akl@opencascade.com>
Date: Mon, 17 Nov 2008 08:46:47 +0000 (+0000)
Subject: Fix issue 0019972: EDF 810 GEOM: doxygen documentation: to exclude 'geompyDC' from... 
X-Git-Tag: V5_1_0rc2~35
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=912c5964b20becc01194ea9fccfd7089ddec91bc;p=modules%2Fgeom.git

Fix issue 0019972: EDF 810 GEOM: doxygen documentation: to exclude 'geompyDC' from documentation and substitute it by 'geompy'.
---

diff --git a/doc/salome/gui/GEOM/Makefile.am b/doc/salome/gui/GEOM/Makefile.am
index 6c746717c..320fde6ec 100755
--- a/doc/salome/gui/GEOM/Makefile.am
+++ b/doc/salome/gui/GEOM/Makefile.am
@@ -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
 
diff --git a/doc/salome/gui/GEOM/doxyfile_py.in b/doc/salome/gui/GEOM/doxyfile_py.in
index 2dcd49341..a484a0cad 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 @@
 <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".
 
 */
diff --git a/doc/salome/tui/Makefile.am b/doc/salome/tui/Makefile.am
index dc1bf5976..fdefb3862 100644
--- a/doc/salome/tui/Makefile.am
+++ b/doc/salome/tui/Makefile.am
@@ -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
diff --git a/doc/salome/tui/doxyfile.in b/doc/salome/tui/doxyfile.in
index 4b69ca9ad..bc7c90595 100755
--- a/doc/salome/tui/doxyfile.in
+++ b/doc/salome/tui/doxyfile.in
@@ -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           =