Changeset 2 for trunk/avango-doc/src/styleguide.dox

Timestamp:

09/24/08 23:00:05 (4 years ago)

Author:

tholt

Message:

documentation polishing

File:

• trunk/avango-doc/src/styleguide.dox (modified) (7 diffs)

trunk/avango-doc/src/styleguide.dox

@@ -3 +3 @@
 /************************************************************************\
 *                                                                        *
-*  Avango Software, Copyright 2001 - 2007 Fraunhofer Gesellschaft        *
-*  zur Foerderung der angewandten Forschung (FhG), Munich, Germany.      *
-*                                                                        *
-*  Avango Software (both binary and source code - if released) is        *
-*  intellectual property owned by FhG and copyrighted by FhG worldwide.  *
-*                                                                        *
-*  Avango is a trademark owned by FhG.                                   *
+* This file is part of Avango.                                           *
+*                                                                        *
+* Copyright 1997 - 2008 Fraunhofer-Gesellschaft zur Foerderung der       *
+* angewandten Forschung (FhG), Munich, Germany.                          *
+*                                                                        *
+* Avango is free software: you can redistribute it and/or modify         *
+* it under the terms of the GNU Lesser General Public License as         *
+* published by the Free Software Foundation, version 3.                  *
+*                                                                        *
+* Avango is distributed in the hope that it will be useful,              *
+* but WITHOUT ANY WARRANTY; without even the implied warranty of         *
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the           *
+* GNU General Public License for more details.                           *
+*                                                                        *
+* You should have received a copy of the GNU Lesser General Public       *
+* License along with Avango. If not, see <http://www.gnu.org/licenses/>. *
+*                                                                        *
+* Avango is a trademark owned by FhG.                                    *
 *                                                                        *
 \************************************************************************/
@@ -30 +41 @@
 
 \section objectives Objectives
-The goal of this guide is to provide standard rules for Avango C++
+The goal of this guide is to provide standard rules for AVANGO C++
 developers which help to maintain a uniform coding style. This not only
 supports easier understanding but should ideally help to produce less
@@ -38 +49 @@
 We start with a general overview over source code layout and naming
 issues before going into the details and providing a minimal template as
-a starting point for your Avango modules.
+a starting point for your AVANGO modules.
 
 \section overall Overall Format
@@ -59 +70 @@
 - Function names have the format: \c word1Word2...();
 - Function arguments have the format: \c word1Word2...
-- Avango Fields have the format: <tt>(S|M)[A]FType Word1Word2...;</tt>
+- AVANGO Fields have the format: <tt>(S|M)[A]FType Word1Word2...;</tt>
 - Other instance members have the format: \c mWord1Word2...
 - Static members have the format: \c sWord1Word2...
@@ -159 +170 @@
 
 \section writetests Write tests
-Write self-contained tests for your modules using the Avango UnitTest++ infrastructure.
+Write self-contained tests for your modules using the AVANGO UnitTest++ infrastructure.
 Link the tests against the final library instead of the separate convenience libraries
 (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
 \endverbatim
-- Use \c Id keyword substitution for all user-generated text-type files,
-  e.g.
-\verbatim
-% svn propset svn:keywords "Id" Makefile.am
-\endverbatim
 - Auto-props are used to set properties on newly added files based on
   their filenames. Functionality can be configured by setting options in
@@ -242 +248 @@
 
 [auto-props]
-*.c = svn:eol-style=native ; svn:keywords=Id
-*.cpp = svn:eol-style=native; svn:keywords=Id
-*.h = svn:eol-style=native; svn:keywords=Id
-*.html = svn:eol-style=native; svn:keywords=Id; svn:mime-type=text/html
-*.m4 = svn:eol-style=native; svn:keywords=Id
+*.c = svn:eol-style=native
+*.c++ = svn:eol-style=native
+*.cpp = svn:eol-style=native
+*.gif = svn:mime-type=image/gif
+*.h = svn:eol-style=native
+*.html = svn:eol-style=native;svn:mime-type=text/html
+*.ico = svn:mime-type=image/x-ico
+*.jpg = svn:mime-type=image/jpeg
+*.m4 = svn:eol-style=native
+*.ml = svn:eol-style=native
+*.mli = svn:eol-style=native
 *.pdf = svn:mime-type=application/pdf
-*.scm = svn:eol-style=native; svn:keywords=Id
-*.sgm = svn:eol-style=native; svn:keywords=Id; svn:mime-type=text/sgml
-*.sh = svn:eol-style=native; svn:keywords=Id; svn:executable
-Makefile* = svn:eol-style=native; svn:keywords=Id
+*.png = svn:mime-type=image/png
+*.py = svn:eol-style=native
+*.rgb = svn:mime-type=image/x-rgb
+*.scm = svn:eol-style=native
+*.sln = svn:eol-style=native
+*.sgi = svn:mime-type=image/x-sgi
+*.sgm = svn:eol-style=native;svn:mime-type=text/sgml
+*.sh = svn:eol-style=native;svn:executable
+*.tif = svn:mime-type=image/tiff
+*.txt = svn:eol-style=native
+*.TXT = svn:eol-style=native
+bootstrap = svn:eol-style=native;svn:executable
+Makefile* = svn:eol-style=native
+SConscript = svn:eol-style=native
+SConstruct = svn:eol-style=native
 \endverbatim