doxygen=@DOXYGEN@
+# Below command replaces "smeshDC" by "smesh" except cases
+# "ssmeshDC", "1smeshDC" and "esmeshDC" (these sequences
+# can be found in file names and must not be replaces):
+#
+# sed 's/\([^s1e]\)smeshDC\|^smeshDC/\1smesh/g' $${filen} > ./tmp;
+#
usr_docs:
cd ./SMESH; \
echo "Processing smeshDC.py file: "; \
$(doxygen) ./doxyfile_py; \
+ cd ./smeshpy_doc; \
+ filesl=`find .`; \
+ for filen in $${filesl}; do \
+ sed 's/\([^s1e]\)smeshDC\|^smeshDC/\1smesh/g' $${filen} > ./tmp; \
+ mv -f tmp $${filen}; \
+ done; \
+ cd ..; \
sed 's|../../../share/salome|$(top_srcdir)|' ./doxyfile > ./doxyfile1; \
mv -f doxyfile1 doxyfile; \
echo "Running doxygen in directory: "`pwd`; \
OUTPUT_LANGUAGE = English
USE_WINDOWS_ENCODING = NO
BRIEF_MEMBER_DESC = YES
-REPEAT_BRIEF = NO
+REPEAT_BRIEF = YES
ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = YES
FULL_PATH_NAMES = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = YES
CASE_SENSE_NAMES = YES
-HIDE_SCOPE_NAMES = NO
+HIDE_SCOPE_NAMES = YES
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = NO
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
-CLASS_DIAGRAMS = YES
+#CLASS_DIAGRAMS = YES
+CLASS_DIAGRAMS = NO
HIDE_UNDOC_RELATIONS = NO
-HAVE_DOT = YES
-CLASS_GRAPH = YES
+#HAVE_DOT = YES
+HAVE_DOT = NO
+#CLASS_GRAPH = YES
+CLASS_GRAPH = NO
COLLABORATION_GRAPH = NO
GROUP_GRAPHS = NO
UML_LOOK = NO
-TEMPLATE_RELATIONS = YES
-INCLUDE_GRAPH = YES
+#TEMPLATE_RELATIONS = YES
+#INCLUDE_GRAPH = YES
+TEMPLATE_RELATIONS = NO
+INCLUDE_GRAPH = NO
INCLUDED_BY_GRAPH = NO
CALL_GRAPH = NO
-GRAPHICAL_HIERARCHY = YES
-DIRECTORY_GRAPH = YES
+#GRAPHICAL_HIERARCHY = YES
+#DIRECTORY_GRAPH = YES
+GRAPHICAL_HIERARCHY = NO
+DIRECTORY_GRAPH = NO
DOT_IMAGE_FORMAT = jpg
DOT_PATH =
DOTFILE_DIRS =
\n Python package smesh defines several classes, destined for easy and
clear mesh creation and edition (see the \ref introduction_to_mesh_python_page "example").
-\n Also, please see \ref smeshDC "documentation for smesh.py"
+\n Please draw your attention to the below notes before address to
+the \ref smeshDC "documentation for smesh.py"
-*/
\ No newline at end of file
+\n 1. The main page of the \ref smeshDC "documentation for smesh.py"
+ contains a list of data structures and a list of functions,
+ provided by the package smesh.py. The first item in the data
+ structures list (\ref smeshDC::smeshDC "class smesh") also
+ represents documentation for methods of the package smesh.py itself.
+
+\n 2. Package smesh.py gives interface to create and manage
+ meshes. Please, use it to create an empty mesh or to import
+ it from data file.
+
+\n 3. Once you have created a mesh, you can manage it via its own
+ methods. See \ref smeshDC::Mesh "class Mesh" documentation for
+ them (it is also accessible by the second item "class Mesh" in the
+ data structures list).
+
+\n 4. Class Mesh allows to assign algorithms to a mesh. To add hypotheses,
+ please use interfaces, provided by the assigned algorithms.
+
+*/
