ForkMaster/smesh
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/smesh.git synced 2025-01-02 21:00:34 +05:00
Code Issues Packages Projects Releases Wiki Activity

NPAL18773: incomprehensible SMESH TUI docs.

Browse Source
This commit is contained in:
jfa 2008-02-14 14:30:20 +00:00
parent 310b145ad6
commit 15e95d02c3
3 changed files with 50 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -27,10 +27,23 @@ EXTRA_DIST+=SMESH
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`; \

25
doc/salome/gui/SMESH/doxyfile_py.in
View File

@ -7,7 +7,7 @@ CREATE_SUBDIRS = NO
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
@ -38,7 +38,7 @@ HIDE_FRIEND_COMPOUNDS = 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
@ -107,19 +107,26 @@ GENERATE_RTF = 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 =

23
doc/salome/gui/SMESH/input/smeshpy_interface.doc
View File

@ -5,6 +5,25 @@
\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"
*/
\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.
*/