ForkMaster/geom
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/geom.git synced 2024-11-15 01:58:36 +05:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
akl 2008-11-17 08:37:46 +00:00
parent 23ee76e527
commit 6dd2eac181
6 changed files with 41 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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".
*/

28
doc/salome/gui/Makefile.am
View File

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

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

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

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

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

26
doc/salome/tui/Makefile.am
View File

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