ForkMaster/geom
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/geom.git synced 2024-12-29 10:50:35 +05:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
akl 2008-11-17 08:46:47 +00:00
parent 26f48fbe3c
commit 912c5964b2
5 changed files with 25 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/salome/gui/GEOM/Makefile.am
View File

@ -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

4
doc/salome/gui/GEOM/doxyfile_py.in
View File

@ -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

2
doc/salome/gui/GEOM/input/geompy.doc
View 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".
*/

13
doc/salome/tui/Makefile.am
View 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

4
doc/salome/tui/doxyfile.in
View File

@ -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 =