Changeset 2
- Timestamp:
- 09/24/08 23:00:05 (3 years ago)
- Location:
- trunk/avango-doc/src
- Files:
-
- 6 edited
-
Doxyfile.in (modified) (2 diffs)
-
SConscript (modified) (4 diffs)
-
index.dox (modified) (2 diffs)
-
styleguide.cpp.expl (modified) (1 diff)
-
styleguide.dox (modified) (7 diffs)
-
styleguide.h.expl (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
trunk/avango-doc/src/Doxyfile.in
r1 r2 26 26 # by quotes) that should identify the project. 27 27 28 PROJECT_NAME = "A vango-NG"28 PROJECT_NAME = "AVANGO" 29 29 30 30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. … … 368 368 # The ENABLED_SECTIONS tag can be used to enable conditional 369 369 # documentation sections, marked by \if sectionname ... \endif. 370 # Section labels used in A vango NGare:370 # Section labels used in AVANGO are: 371 371 # DOXYGEN_SHOULD_SKIP_THIS : ignoring some lines of code while generating docu 372 372 -
trunk/avango-doc/src/SConscript
r1 r2 68 68 69 69 doxygen_install_pdf = doc_env.InstallAs( 70 target = avango.build.get_documentation_path().abspath + '/avango -ng.pdf',70 target = avango.build.get_documentation_path().abspath + '/avango.pdf', 71 71 source = 'latex/refman.pdf') 72 72 … … 75 75 'html/epydoc/index.html', 76 76 '', 77 'epydoc --name "A vango-NGPython Bindings" --docformat="restructuredtext" --html'77 'epydoc --name "AVANGO Python Bindings" --docformat="restructuredtext" --html' 78 78 + ' --graph="classtree" --src-code-tab-width="2" --exclude-introspect="daemon" -o . ' 79 79 + avango.build.get_python_path().abspath + '/avango', … … 83 83 'epydoc-latex/api.pdf', 84 84 '', 85 'epydoc --name "A vango-NGPython Bindings" --docformat="restructuredtext" --pdf'85 'epydoc --name "AVANGO Python Bindings" --docformat="restructuredtext" --pdf' 86 86 + ' --no-private --graph="classtree" --src-code-tab-width="2" --exclude-introspect="daemon" -o . ' 87 87 + avango.build.get_python_path().abspath + '/avango', … … 93 93 # epydoc install 94 94 epydoc_install_pdf = doc_env.InstallAs( 95 target = avango.build.get_documentation_path().abspath + '/avango- ng-python.pdf',95 target = avango.build.get_documentation_path().abspath + '/avango-python.pdf', 96 96 source = 'epydoc-latex/api.pdf') 97 97 -
trunk/avango-doc/src/index.dox
r1 r2 3 3 /************************************************************************\ 4 4 * * 5 * Avango Software, Copyright 2001 - 2007 Fraunhofer Gesellschaft * 6 * zur Foerderung der angewandten Forschung (FhG), Munich, Germany. * 5 * This file is part of Avango. * 7 6 * * 8 * Avango Software (both binary and source code - if released) is*9 * intellectual property owned by FhG and copyrighted by FhG worldwide.*7 * Copyright 1997 - 2008 Fraunhofer-Gesellschaft zur Foerderung der * 8 * angewandten Forschung (FhG), Munich, Germany. * 10 9 * * 11 * Avango is a trademark owned by FhG. * 10 * Avango is free software: you can redistribute it and/or modify * 11 * it under the terms of the GNU Lesser General Public License as * 12 * published by the Free Software Foundation, version 3. * 13 * * 14 * Avango is distributed in the hope that it will be useful, * 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of * 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * 17 * GNU General Public License for more details. * 18 * * 19 * You should have received a copy of the GNU Lesser General Public * 20 * License along with Avango. If not, see <http://www.gnu.org/licenses/>. * 21 * * 22 * Avango is a trademark owned by FhG. * 12 23 * * 13 24 \************************************************************************/ … … 23 34 \section external External Documents 24 35 25 - <a target="_blank" href="epydoc/index.html">A vango-NGPython Bindings</a>36 - <a target="_blank" href="epydoc/index.html">AVANGO Python Bindings</a> 26 37 27 - <a target="_blank" href="../avango -ng.pdf">PDF Avango-NGReference Manual</a>28 - <a target="_blank" href="../avango- ng-python.pdf">PDF Avango-NGPython Bindings</a>38 - <a target="_blank" href="../avango.pdf">PDF AVANGO Reference Manual</a> 39 - <a target="_blank" href="../avango-python.pdf">PDF AVANGO Python Bindings</a> 29 40 30 41 */ -
trunk/avango-doc/src/styleguide.cpp.expl
r1 r2 3 3 /************************************************************************\ 4 4 * * 5 * Avango Software, Copyright 2001 - 2007 Fraunhofer Gesellschaft * 6 * zur Foerderung der angewandten Forschung (FhG), Munich, Germany. * 5 * This file is part of Avango. * 7 6 * * 8 * Avango Software (both binary and source code - if released) is*9 * intellectual property owned by FhG and copyrighted by FhG worldwide.*7 * Copyright 1997 - 2008 Fraunhofer-Gesellschaft zur Foerderung der * 8 * angewandten Forschung (FhG), Munich, Germany. * 10 9 * * 11 * Avango is a trademark owned by FhG. * 10 * Avango is free software: you can redistribute it and/or modify * 11 * it under the terms of the GNU Lesser General Public License as * 12 * published by the Free Software Foundation, version 3. * 13 * * 14 * Avango is distributed in the hope that it will be useful, * 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of * 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * 17 * GNU General Public License for more details. * 18 * * 19 * You should have received a copy of the GNU Lesser General Public * 20 * License along with Avango. If not, see <http://www.gnu.org/licenses/>. * 21 * * 22 * Avango is a trademark owned by FhG. * 12 23 * * 13 24 \************************************************************************/ -
trunk/avango-doc/src/styleguide.dox
r1 r2 3 3 /************************************************************************\ 4 4 * * 5 * Avango Software, Copyright 2001 - 2007 Fraunhofer Gesellschaft * 6 * zur Foerderung der angewandten Forschung (FhG), Munich, Germany. * 7 * * 8 * Avango Software (both binary and source code - if released) is * 9 * intellectual property owned by FhG and copyrighted by FhG worldwide. * 10 * * 11 * Avango is a trademark owned by FhG. * 5 * This file is part of Avango. * 6 * * 7 * Copyright 1997 - 2008 Fraunhofer-Gesellschaft zur Foerderung der * 8 * angewandten Forschung (FhG), Munich, Germany. * 9 * * 10 * Avango is free software: you can redistribute it and/or modify * 11 * it under the terms of the GNU Lesser General Public License as * 12 * published by the Free Software Foundation, version 3. * 13 * * 14 * Avango is distributed in the hope that it will be useful, * 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of * 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * 17 * GNU General Public License for more details. * 18 * * 19 * You should have received a copy of the GNU Lesser General Public * 20 * License along with Avango. If not, see <http://www.gnu.org/licenses/>. * 21 * * 22 * Avango is a trademark owned by FhG. * 12 23 * * 13 24 \************************************************************************/ … … 30 41 31 42 \section objectives Objectives 32 The goal of this guide is to provide standard rules for A vangoC++43 The goal of this guide is to provide standard rules for AVANGO C++ 33 44 developers which help to maintain a uniform coding style. This not only 34 45 supports easier understanding but should ideally help to produce less … … 38 49 We start with a general overview over source code layout and naming 39 50 issues before going into the details and providing a minimal template as 40 a starting point for your A vangomodules.51 a starting point for your AVANGO modules. 41 52 42 53 \section overall Overall Format … … 59 70 - Function names have the format: \c word1Word2...(); 60 71 - Function arguments have the format: \c word1Word2... 61 - A vangoFields have the format: <tt>(S|M)[A]FType Word1Word2...;</tt>72 - AVANGO Fields have the format: <tt>(S|M)[A]FType Word1Word2...;</tt> 62 73 - Other instance members have the format: \c mWord1Word2... 63 74 - Static members have the format: \c sWord1Word2... … … 159 170 160 171 \section writetests Write tests 161 Write self-contained tests for your modules using the A vangoUnitTest++ infrastructure.172 Write self-contained tests for your modules using the AVANGO UnitTest++ infrastructure. 162 173 Link the tests against the final library instead of the separate convenience libraries 163 174 (e.g. don't use libfields.la but libavango.la). This way we don't run into trouble when … … 228 239 % svn propset svn:mime-type "application/pdf" some.pdf 229 240 \endverbatim 230 - Use \c Id keyword substitution for all user-generated text-type files,231 e.g.232 \verbatim233 % svn propset svn:keywords "Id" Makefile.am234 \endverbatim235 241 - Auto-props are used to set properties on newly added files based on 236 242 their filenames. Functionality can be configured by setting options in … … 242 248 243 249 [auto-props] 244 *.c = svn:eol-style=native ; svn:keywords=Id 245 *.cpp = svn:eol-style=native; svn:keywords=Id 246 *.h = svn:eol-style=native; svn:keywords=Id 247 *.html = svn:eol-style=native; svn:keywords=Id; svn:mime-type=text/html 248 *.m4 = svn:eol-style=native; svn:keywords=Id 250 *.c = svn:eol-style=native 251 *.c++ = svn:eol-style=native 252 *.cpp = svn:eol-style=native 253 *.gif = svn:mime-type=image/gif 254 *.h = svn:eol-style=native 255 *.html = svn:eol-style=native;svn:mime-type=text/html 256 *.ico = svn:mime-type=image/x-ico 257 *.jpg = svn:mime-type=image/jpeg 258 *.m4 = svn:eol-style=native 259 *.ml = svn:eol-style=native 260 *.mli = svn:eol-style=native 249 261 *.pdf = svn:mime-type=application/pdf 250 *.scm = svn:eol-style=native; svn:keywords=Id 251 *.sgm = svn:eol-style=native; svn:keywords=Id; svn:mime-type=text/sgml 252 *.sh = svn:eol-style=native; svn:keywords=Id; svn:executable 253 Makefile* = svn:eol-style=native; svn:keywords=Id 262 *.png = svn:mime-type=image/png 263 *.py = svn:eol-style=native 264 *.rgb = svn:mime-type=image/x-rgb 265 *.scm = svn:eol-style=native 266 *.sln = svn:eol-style=native 267 *.sgi = svn:mime-type=image/x-sgi 268 *.sgm = svn:eol-style=native;svn:mime-type=text/sgml 269 *.sh = svn:eol-style=native;svn:executable 270 *.tif = svn:mime-type=image/tiff 271 *.txt = svn:eol-style=native 272 *.TXT = svn:eol-style=native 273 bootstrap = svn:eol-style=native;svn:executable 274 Makefile* = svn:eol-style=native 275 SConscript = svn:eol-style=native 276 SConstruct = svn:eol-style=native 254 277 \endverbatim 255 278 -
trunk/avango-doc/src/styleguide.h.expl
r1 r2 3 3 /************************************************************************\ 4 4 * * 5 * Avango Software, Copyright 2001 - 2007 Fraunhofer Gesellschaft * 6 * zur Foerderung der angewandten Forschung (FhG), Munich, Germany. * 5 * This file is part of Avango. * 7 6 * * 8 * Avango Software (both binary and source code - if released) is*9 * intellectual property owned by FhG and copyrighted by FhG worldwide.*7 * Copyright 1997 - 2008 Fraunhofer-Gesellschaft zur Foerderung der * 8 * angewandten Forschung (FhG), Munich, Germany. * 10 9 * * 11 * Avango is a trademark owned by FhG. * 10 * Avango is free software: you can redistribute it and/or modify * 11 * it under the terms of the GNU Lesser General Public License as * 12 * published by the Free Software Foundation, version 3. * 13 * * 14 * Avango is distributed in the hope that it will be useful, * 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of * 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * 17 * GNU General Public License for more details. * 18 * * 19 * You should have received a copy of the GNU Lesser General Public * 20 * License along with Avango. If not, see <http://www.gnu.org/licenses/>. * 21 * * 22 * Avango is a trademark owned by FhG. * 12 23 * * 13 24 \************************************************************************/
Note: See TracChangeset
for help on using the changeset viewer.
