diff --git a/livesupport/doc/developmentEnvironment/autoconfConfigureConventions.html b/livesupport/doc/developmentEnvironment/autoconfConfigureConventions.html index bb30c9f66..c84e51d85 100644 --- a/livesupport/doc/developmentEnvironment/autoconfConfigureConventions.html +++ b/livesupport/doc/developmentEnvironment/autoconfConfigureConventions.html @@ -1,27 +1,28 @@ - + autoconf configure file conventions

Preface

This document is part of the LiveSupport -project, Copyright © 2004 Media +project, Copyright © 2004 Media Development Loan Fund, under the GNU GPL.

Scope

This document describes the autoconf configure file conventions for the LiveSupport project. See also the generic description of the file + href="fileConventions.html">file conventions in the LiveSupport project.

Introduction

@@ -53,7 +54,7 @@ The header holds all information mandated by the dnl. Note the 80 column wide partitioning delimiter enclosing the header.
-
dnl-----------------------------------------------------------------------------
dnl Copyright (c) 2004 Media Development Loan Fund
dnl
dnl This file is part of the LiveSupport project.
dnl http://livesupport.campware.org/
dnl To report bugs, send an e-mail to bugs@campware.org
dnl
dnl LiveSupport is free software; you can redistribute it and/or modify
dnl it under the terms of the GNU General Public License as published by
dnl the Free Software Foundation; either version 2 of the License, or
dnl (at your option) any later version.
dnl
dnl LiveSupport is distributed in the hope that it will be useful,
dnl but WITHOUT ANY WARRANTY; without even the implied warranty of
dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
dnl GNU General Public License for more details.
dnl
dnl You should have received a copy of the GNU General Public License
dnl along with LiveSupport; if not, write to the Free Software
dnl Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
dnl
dnl
dnl Author   : $Author: maroy $
dnl Version  : $Revision: 1.1 $
dnl Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/developmentEnvironment/autoconfConfigureConventions.html,v $
dnl-----------------------------------------------------------------------------
+
dnl-----------------------------------------------------------------------------
dnl Copyright (c) 2004 Media Development Loan Fund
dnl
dnl This file is part of the LiveSupport project.
dnl http://livesupport.campware.org/
dnl To report bugs, send an e-mail to bugs@campware.org
dnl
dnl LiveSupport is free software; you can redistribute it and/or modify
dnl it under the terms of the GNU General Public License as published by
dnl the Free Software Foundation; either version 2 of the License, or
dnl (at your option) any later version.
dnl
dnl LiveSupport is distributed in the hope that it will be useful,
dnl but WITHOUT ANY WARRANTY; without even the implied warranty of
dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
dnl GNU General Public License for more details.
dnl
dnl You should have received a copy of the GNU General Public License
dnl along with LiveSupport; if not, write to the Free Software
dnl Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
dnl
dnl
dnl Author   : $Author: maroy $
dnl Version  : $Revision: 1.2 $
dnl Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/developmentEnvironment/autoconfConfigureConventions.html,v $
dnl-----------------------------------------------------------------------------

Additional sections

Additional sections contain the autoconf configuration macro calls. Bigger diff --git a/livesupport/doc/developmentEnvironment/cxxHeaderFileConventions.html b/livesupport/doc/developmentEnvironment/cxxHeaderFileConventions.html index 4c244c101..f30456456 100644 --- a/livesupport/doc/developmentEnvironment/cxxHeaderFileConventions.html +++ b/livesupport/doc/developmentEnvironment/cxxHeaderFileConventions.html @@ -1,27 +1,28 @@ - + C++ header file conventions

Preface

This document is part of the LiveSupport -project, Copyright © 2004 Media +project, Copyright © 2004 Media Development Loan Fund, under the GNU GPL.

Scope

This document describes C++ header file conventions for the LiveSupport project. See also the generic description of the file + href="fileConventions.html">file conventions in the LiveSupport project.

Introduction

@@ -95,7 +96,7 @@ compiler).
A sample for a C++ header file header follows, where the file itself would be expected to be included as "LiveSupport/Foo/Bar.h".

-
/*------------------------------------------------------------------------------

    Copyright (c) 2004 Media Development Loan Fund
                                                                                
    This file is part of the LiveSupport project.
    http://livesupport.campware.org/
    To report bugs, send an e-mail to bugs@campware.org
                                                                                
    LiveSupport is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
                                                                                
    LiveSupport 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 General Public License
    along with LiveSupport; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                                                                                
                                                                                
    Author   : $Author: maroy $
    Version  : $Revision: 1.1 $
    Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/developmentEnvironment/cxxHeaderFileConventions.html,v $
                                                                                
------------------------------------------------------------------------------*/
#ifndef LiveSupport_Foo_Bar_h
#define LiveSupport_Foo_Bar_h
                                                                                
#ifndef __cplusplus
#error This is a C++ include file
#endif

+
/*------------------------------------------------------------------------------

    Copyright (c) 2004 Media Development Loan Fund
                                                                                
    This file is part of the LiveSupport project.
    http://livesupport.campware.org/
    To report bugs, send an e-mail to bugs@campware.org
                                                                                
    LiveSupport is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
                                                                                
    LiveSupport 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 General Public License
    along with LiveSupport; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                                                                                
                                                                                
    Author   : $Author: maroy $
    Version  : $Revision: 1.2 $
    Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/developmentEnvironment/cxxHeaderFileConventions.html,v $
                                                                                
------------------------------------------------------------------------------*/
#ifndef LiveSupport_Foo_Bar_h
#define LiveSupport_Foo_Bar_h
                                                                                
#ifndef __cplusplus
#error This is a C++ include file
#endif

Include files & namespace

This section contains all the include files that the header file needs @@ -162,7 +163,7 @@ Within each of the above blocks, the order is the following:
For proper indentation of the above blocks, see the example below.

Sample

A sample data types section follows.
-
/* =============================================================== data types */

/**
 *  Hello class.
 *  The only purpose of this class is to say hello.
 *
 *  @author  $Author: maroy $
 *  @version $Revision: 1.1 $
 */
class Hello
{
    private:
        /**
         *  Our famous hello string.
         */
        static const std::string        helloWorld;

    public:
        /**
         *  Default constructor.
         */
        Hello (void)                                    throw ()
        {
        }

        /**
         *  Say hello.
         *
         *  @return the string "Hello, World!"
         *  @exception std::exception on problems
         */
        const std::string
        hello (void)                        throw (std::exception)
        {
            return helloWorld;
        }
};

+
/* =============================================================== data types */

/**
 *  Hello class.
 *  The only purpose of this class is to say hello.
 *
 *  @author  $Author: maroy $
 *  @version $Revision: 1.2 $
 */
class Hello
{
    private:
        /**
         *  Our famous hello string.
         */
        static const std::string        helloWorld;

    public:
        /**
         *  Default constructor.
         */
        Hello (void)                                    throw ()
        {
        }

        /**
         *  Say hello.
         *
         *  @return the string "Hello, World!"
         *  @exception std::exception on problems
         */
        const std::string
        hello (void)                        throw (std::exception)
        {
            return helloWorld;
        }
};

External data structures

The external data structures section contains any external data diff --git a/livesupport/doc/developmentEnvironment/cxxSourceFileConventions.html b/livesupport/doc/developmentEnvironment/cxxSourceFileConventions.html index bb0eef9eb..ccb0a63f5 100644 --- a/livesupport/doc/developmentEnvironment/cxxSourceFileConventions.html +++ b/livesupport/doc/developmentEnvironment/cxxSourceFileConventions.html @@ -1,27 +1,28 @@ - + C++ source file conventions

Preface

This document is part of the LiveSupport -project, Copyright © 2004 Media +project, Copyright © 2004 Media Development Loan Fund, under the GNU GPL.

Scope

This document describes C++ source file conventions for the LiveSupport project. See also the generic description of the file + href="fileConventions.html">file conventions in the LiveSupport project.

Introduction

@@ -84,7 +85,7 @@ with the generic header information, enclosed in 80 column wide partitioning delimiters.

Sample

A sample for a C++ source file header follows.
-
/*------------------------------------------------------------------------------

    Copyright (c) 2004 Media Development Loan Fund
                                                                                
    This file is part of the LiveSupport project.
    http://livesupport.campware.org/
    To report bugs, send an e-mail to bugs@campware.org
                                                                                
    LiveSupport is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
                                                                                
    LiveSupport 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 General Public License
    along with LiveSupport; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                                                                                
                                                                                
    Author   : $Author: maroy $
    Version  : $Revision: 1.1 $
    Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/developmentEnvironment/cxxSourceFileConventions.html,v $
                                                                                
------------------------------------------------------------------------------*/

+
/*------------------------------------------------------------------------------

    Copyright (c) 2004 Media Development Loan Fund
                                                                                
    This file is part of the LiveSupport project.
    http://livesupport.campware.org/
    To report bugs, send an e-mail to bugs@campware.org
                                                                                
    LiveSupport is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
                                                                                
    LiveSupport 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 General Public License
    along with LiveSupport; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                                                                                
                                                                                
    Author   : $Author: maroy $
    Version  : $Revision: 1.2 $
    Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/developmentEnvironment/cxxSourceFileConventions.html,v $
                                                                                
------------------------------------------------------------------------------*/

Include files & namespaces

This section contains all the include files that the source file needs diff --git a/livesupport/doc/developmentEnvironment/index.html b/livesupport/doc/developmentEnvironment/index.html index 2bdf68d0d..756ae9bba 100644 --- a/livesupport/doc/developmentEnvironment/index.html +++ b/livesupport/doc/developmentEnvironment/index.html @@ -1,21 +1,21 @@ - + LiveSupport development environment

Preface

This document is part of the LiveSupport -project, Copyright © 2004 Media +project, Copyright © 2004 Media Development Loan Fund, under the GNU GPL.

Scope

This document gives an overview of the LiveSupport development @@ -27,8 +27,7 @@ aspects of the environment are defined so far:

diff --git a/livesupport/doc/developmentEnvironment/makefileConventions.html b/livesupport/doc/developmentEnvironment/makefileConventions.html index 26c42aa21..5312ce0ef 100644 --- a/livesupport/doc/developmentEnvironment/makefileConventions.html +++ b/livesupport/doc/developmentEnvironment/makefileConventions.html @@ -1,27 +1,28 @@ - + Makefile conventions

Preface

This document is part of the LiveSupport -project, Copyright © 2004 Media +project, Copyright © 2004 Media Development Loan Fund, under the GNU GPL.

Scope

This document describes the Makefile file conventions for the LiveSupport project. See also the generic description of the file + href="fileConventions.html">file conventions in the LiveSupport project. This document does not describe the mandatory targets for Makefiles, see the build environment @@ -59,7 +60,7 @@ The header holds all information mandated by the #. Note the 80 column wide partitioning delimiter enclosing the header.
-
#-------------------------------------------------------------------------------
#   Copyright (c) 2004 Media Development Loan Fund
#
#   This file is part of the LiveSupport project.
#   http://livesupport.campware.org/
#   To report bugs, send an e-mail to bugs@campware.org
#
#   LiveSupport is free software; you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 2 of the License, or
#   (at your option) any later version.
#
#   LiveSupport 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 General Public License
#   along with LiveSupport; if not, write to the Free Software
#   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
#
#   Author   : $Author: maroy $
#   Version  : $Revision: 1.1 $
#   Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/developmentEnvironment/makefileConventions.html,v $
#-------------------------------------------------------------------------------
+
#-------------------------------------------------------------------------------
#   Copyright (c) 2004 Media Development Loan Fund
#
#   This file is part of the LiveSupport project.
#   http://livesupport.campware.org/
#   To report bugs, send an e-mail to bugs@campware.org
#
#   LiveSupport is free software; you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 2 of the License, or
#   (at your option) any later version.
#
#   LiveSupport 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 General Public License
#   along with LiveSupport; if not, write to the Free Software
#   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
#
#   Author   : $Author: maroy $
#   Version  : $Revision: 1.2 $
#   Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/developmentEnvironment/makefileConventions.html,v $
#-------------------------------------------------------------------------------

General command definitions

This section contains definitions to commands used when executing the diff --git a/livesupport/doc/developmentEnvironment/shellScriptConventions.html b/livesupport/doc/developmentEnvironment/shellScriptConventions.html index 66ea9a32e..cc0cca15d 100644 --- a/livesupport/doc/developmentEnvironment/shellScriptConventions.html +++ b/livesupport/doc/developmentEnvironment/shellScriptConventions.html @@ -1,27 +1,28 @@ - + shell script conventions

Preface

This document is part of the LiveSupport -project, Copyright © 2004 Media +project, Copyright © 2004 Media Development Loan Fund, under the GNU GPL.

Scope

This document describes the shell script file conventions for the LiveSupport project. See also the generic description of the file + href="fileConventions.html">file conventions in the LiveSupport project.

Introduction

@@ -63,7 +64,7 @@ The header holds all information mandated by the generic guidelines, but starting with the shell comment character #. Note the 80 column wide partitioning delimiter enclosing the header.
-
#-------------------------------------------------------------------------------
#   Copyright (c) 2004 Media Development Loan Fund
#
#   This file is part of the LiveSupport project.
#   http://livesupport.campware.org/
#   To report bugs, send an e-mail to bugs@campware.org
#
#   LiveSupport is free software; you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 2 of the License, or
#   (at your option) any later version.
#
#   LiveSupport 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 General Public License
#   along with LiveSupport; if not, write to the Free Software
#   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
#
#   Author   : $Author: maroy $
#   Version  : $Revision: 1.1 $
#   Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/developmentEnvironment/shellScriptConventions.html,v $
#-------------------------------------------------------------------------------
+
#-------------------------------------------------------------------------------
#   Copyright (c) 2004 Media Development Loan Fund
#
#   This file is part of the LiveSupport project.
#   http://livesupport.campware.org/
#   To report bugs, send an e-mail to bugs@campware.org
#
#   LiveSupport is free software; you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 2 of the License, or
#   (at your option) any later version.
#
#   LiveSupport 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 General Public License
#   along with LiveSupport; if not, write to the Free Software
#   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
#
#   Author   : $Author: maroy $
#   Version  : $Revision: 1.2 $
#   Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/developmentEnvironment/shellScriptConventions.html,v $
#-------------------------------------------------------------------------------

Additional sections

Additional sections contain the executing code of the script. Bigger parts of the script may be partitioned by the partitioning commend seen