Remove documentation in triple double quotes in Python script to avoid it in generated pages.

This commit is contained in:
akl 2013-04-05 11:33:20 +00:00
parent 3f9390adf4
commit c55226dc9d
3 changed files with 7 additions and 3 deletions

View File

@ -30,6 +30,10 @@ guidocdir = $(docdir)/gui/GEOM
guidoc_DATA = images/head.png static/SALOME_BOA_PA.pdf guidoc_DATA = images/head.png static/SALOME_BOA_PA.pdf
usr_docs: doxyfile_tui doxyfile_py doxyfile usr_docs: doxyfile_tui doxyfile_py doxyfile
echo "===========================================" ; \
echo "Process geomBuilder.py for documentation generation" ; \
echo "===========================================" ; \
$(KERNEL_ROOT_DIR)/bin/salome/prepare_generating_doc.py $(top_srcdir)/src/GEOM_SWIG/geomBuilder.py ;\
echo "===========================================" ; \ echo "===========================================" ; \
echo "Generating examples documentation" ; \ echo "Generating examples documentation" ; \
echo "===========================================" ; \ echo "===========================================" ; \
@ -42,7 +46,7 @@ usr_docs: doxyfile_tui doxyfile_py doxyfile
echo "Generating GUI documentation" ; \ echo "Generating GUI documentation" ; \
echo "===========================================" ; \ echo "===========================================" ; \
$(DOXYGEN) doxyfile ; \ $(DOXYGEN) doxyfile ; \
rm -f ./geompy.py rm -f ./geomBuilder.py
docs: usr_docs docs: usr_docs

View File

@ -99,7 +99,7 @@ EXAMPLE_RECURSIVE = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
#Input related options #Input related options
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
INPUT = @top_srcdir@/src/GEOM_SWIG/geomBuilder.py @top_srcdir@/src/GEOM_SWIG/gsketcher.py @top_srcdir@/idl/GEOM_Gen.idl INPUT = geomBuilder.py @top_srcdir@/src/GEOM_SWIG/gsketcher.py @top_srcdir@/idl/GEOM_Gen.idl
FILE_PATTERNS = FILE_PATTERNS =
IMAGE_PATH = @srcdir@/images IMAGE_PATH = @srcdir@/images
EXAMPLE_PATH = @top_srcdir@/src/GEOM_SWIG EXAMPLE_PATH = @top_srcdir@/src/GEOM_SWIG

View File

@ -6,7 +6,7 @@
<a href="geompy_doc/modules.html">structured documentation for geomBuilder.py</a>, <a href="geompy_doc/modules.html">structured documentation for geomBuilder.py</a>,
where all package functionality is separated in groups by purpose. where all package functionality is separated in groups by purpose.
\n Also you can find any function in the \ref GEOM_SWIG.geomBuilder \n Also you can find any function in the \ref geomBuilder
"linear documentation for geomBuilder.py". "linear documentation for geomBuilder.py".
\n \n