From: <rus...@us...> - 2008-04-21 11:52:58
|
Revision: 116 http://gearbox.svn.sourceforge.net/gearbox/?rev=116&view=rev Author: russo2503v Date: 2008-04-21 04:53:02 -0700 (Mon, 21 Apr 2008) Log Message: ----------- fixed most of doxygen warnings Modified Paths: -------------- gearbox/trunk/cmake/FindIceUtil.cmake gearbox/trunk/doc/doxyfile gearbox/trunk/doc/index.dox gearbox/trunk/doc/principles.dox gearbox/trunk/src/gbxserialacfr/serial.h gearbox/trunk/src/gbxsickacfr/doc.dox gearbox/trunk/src/gbxsickacfr/gbxiceutilacfr/store.h gearbox/trunk/src/urg_nz/urg_nz.h Added Paths: ----------- gearbox/trunk/doc/history.dox gearbox/trunk/src/basicexample/doc.dox gearbox/trunk/src/gbxadvancedexample/doc.dox gearbox/trunk/src/urg_nz/doc.dox Removed Paths: ------------- gearbox/trunk/src/basicexample/basicexample.dox gearbox/trunk/src/gbxadvancedexample/gbxadvancedexample.dox gearbox/trunk/src/urg_nz/urg_nz.dox Modified: gearbox/trunk/cmake/FindIceUtil.cmake =================================================================== --- gearbox/trunk/cmake/FindIceUtil.cmake 2008-04-21 10:27:26 UTC (rev 115) +++ gearbox/trunk/cmake/FindIceUtil.cmake 2008-04-21 11:53:02 UTC (rev 116) @@ -22,11 +22,15 @@ # debian package installs Ice here /usr/include/IceUtil # Test standard installation points: newer versions first - /opt/Ice-3.2.1/include/IceUtil - /opt/Ice-3.2.0/include/IceUtil + /opt/Ice-3.3/include/IceUtil + /opt/Ice-3.2/include/IceUtil # some people may manually choose to install Ice here /usr/local/include/IceUtil # windows + C:/Ice-3.3.0-VC80/include/IceUtil + C:/Ice-3.3.0/include/IceUtil + C:/Ice-3.2.1-VC80/include/IceUtil + C:/Ice-3.2.1/include/IceUtil C:/Ice-3.2.0-VC80/include/IceUtil C:/Ice-3.2.0/include/IceUtil ) Modified: gearbox/trunk/doc/doxyfile =================================================================== --- gearbox/trunk/doc/doxyfile 2008-04-21 10:27:26 UTC (rev 115) +++ gearbox/trunk/doc/doxyfile 2008-04-21 11:53:02 UTC (rev 116) @@ -83,7 +83,7 @@ *.c \ *.cc RECURSIVE = YES -EXCLUDE = +EXCLUDE = ../src/gbxsickacfr/gbxiceutilacfr/ EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = EXAMPLE_PATH = ../src Added: gearbox/trunk/doc/history.dox =================================================================== --- gearbox/trunk/doc/history.dox (rev 0) +++ gearbox/trunk/doc/history.dox 2008-04-21 11:53:02 UTC (rev 116) @@ -0,0 +1,44 @@ +/* + * GearBox Project: Peer-Reviewed Open-Source Libraries for Robotics + * http://gearbox.sf.net/ + * Copyright (c) 2008 GearBox Team + * + * This distribution is licensed to you under the terms described in + * the LICENSE file included in this distribution. + * + */ + +TEMPLATE +@section gbx_doc_history_head Changes in SVN since Last Release +@par Project wide +@par New libraries +@par Updated libraries +@par Removed libraries + +/*! + +@page gbx_doc_history Changes since Last Release and To-Do List + +Developers: as you make substantial changes in the code (add features, fix bugs, etc.), add an item in the section on changes. When the next version is released, this list will be copied into the release notes. + +@section hydro_doc_todo_todo To-Do List for Next Release + +@section gbx_doc_history_100 Changes in Release 1.0.0 + +@par Project wide + +- First release. + +@par New libraries + +- liburg_nz + - moved from the Player project + +- libGbxSerialAcfr + - moved from the Orca project + +- libGbxSickAcfr + - moved from the Orca project + + +*/ Modified: gearbox/trunk/doc/index.dox =================================================================== --- gearbox/trunk/doc/index.dox 2008-04-21 10:27:26 UTC (rev 115) +++ gearbox/trunk/doc/index.dox 2008-04-21 11:53:02 UTC (rev 116) @@ -45,6 +45,7 @@ @section gbx_doc_index_news News +- 21-Apr-08 First release, version 1.0 (@ref gbx_doc_history_100) - 18-Mar-08 Accepted ACFR's implementation of SICK laser driver and the serial library used by it. - 08-Feb-08 Accepted the first library: a driver for the URG laser. - 01-Feb-08 Project created. @ref gbx_doc_announce "A half-page announcement". Modified: gearbox/trunk/doc/principles.dox =================================================================== --- gearbox/trunk/doc/principles.dox 2008-04-21 10:27:26 UTC (rev 115) +++ gearbox/trunk/doc/principles.dox 2008-04-21 11:53:02 UTC (rev 116) @@ -166,7 +166,7 @@ - variables, member variables, classes, structs, namespaces - functions, member functions -- #defines, enums +- \#defines, enums - filenames - API usage style Deleted: gearbox/trunk/src/basicexample/basicexample.dox =================================================================== --- gearbox/trunk/src/basicexample/basicexample.dox 2008-04-21 10:27:26 UTC (rev 115) +++ gearbox/trunk/src/basicexample/basicexample.dox 2008-04-21 11:53:02 UTC (rev 116) @@ -1,34 +0,0 @@ -/*! - -@ingroup gbx_libs -@ingroup gbx_examples -@ingroup gbx_c -@ingroup gbx_win -@ingroup gbx_linux -@defgroup gbx_library_basicexample libbasicexample -@brief A build-system example of setting up a library with no dependencies. - -@par General notes - -All double's and int's are initialized to zero. - -For a full list of functions and classes see @ref basicexample. - -Header file: -@verbatim -#include <basicexample/basicexample.h> -@endverbatim - -@par Responsible Developer -Alex Makarenko - -*/ - -/*! -@namespace basicexample -@brief Namespace for the basic build system example. - -This namespace is part of a library serving as a basic build system example. - -@see @ref gbx_library_basicexample -*/ Copied: gearbox/trunk/src/basicexample/doc.dox (from rev 114, gearbox/trunk/src/basicexample/basicexample.dox) =================================================================== --- gearbox/trunk/src/basicexample/doc.dox (rev 0) +++ gearbox/trunk/src/basicexample/doc.dox 2008-04-21 11:53:02 UTC (rev 116) @@ -0,0 +1,34 @@ +/*! + +@ingroup gbx_libs +@ingroup gbx_examples +@ingroup gbx_c +@ingroup gbx_win +@ingroup gbx_linux +@defgroup gbx_library_basicexample libbasicexample +@brief A build-system example of setting up a library with no dependencies. + +@par General notes + +All double's and int's are initialized to zero. + +For a full list of functions and classes see @ref basicexample. + +Header file: +@verbatim +#include <basicexample/basicexample.h> +@endverbatim + +@par Responsible Developer +Alex Makarenko + +*/ + +/*! +@namespace basicexample +@brief Namespace for the basic build system example. + +This namespace is part of a library serving as a basic build system example. + +@see @ref gbx_library_basicexample +*/ Copied: gearbox/trunk/src/gbxadvancedexample/doc.dox (from rev 114, gearbox/trunk/src/gbxadvancedexample/gbxadvancedexample.dox) =================================================================== --- gearbox/trunk/src/gbxadvancedexample/doc.dox (rev 0) +++ gearbox/trunk/src/gbxadvancedexample/doc.dox 2008-04-21 11:53:02 UTC (rev 116) @@ -0,0 +1,33 @@ +/*! + +@ingroup gbx_libs +@ingroup gbx_examples +@ingroup gbx_cpp +@ingroup gbx_linux +@defgroup gbx_library_gbxadvancedexample libGbxAdvancedExample +@brief A build-system example of setting up a library with an internal dependency. + +@par General notes + +All double's and int's are initialized to zero. + +For a full list of functions and classes see @ref gbxadvancedexample. + +Header file: +@verbatim +#include <gbxadvancedexample/gbxadvancedexample.h> +@endverbatim + +@par Responsible Developer +Alex Makarenko + +*/ + +/*! +@namespace gbxadvancedexample +@brief Namespace for the advanced build system example. + +This namespace is part of a library serving as an advanced build system example. + +@see @ref gbx_library_gbxadvancedexample +*/ Deleted: gearbox/trunk/src/gbxadvancedexample/gbxadvancedexample.dox =================================================================== --- gearbox/trunk/src/gbxadvancedexample/gbxadvancedexample.dox 2008-04-21 10:27:26 UTC (rev 115) +++ gearbox/trunk/src/gbxadvancedexample/gbxadvancedexample.dox 2008-04-21 11:53:02 UTC (rev 116) @@ -1,33 +0,0 @@ -/*! - -@ingroup gbx_libs -@ingroup gbx_examples -@ingroup gbx_cpp -@ingroup gbx_linux -@defgroup gbx_library_gbxadvancedexample libGbxAdvancedExample -@brief A build-system example of setting up a library with an internal dependency. - -@par General notes - -All double's and int's are initialized to zero. - -For a full list of functions and classes see @ref gbxadvancedexample. - -Header file: -@verbatim -#include <gbxadvancedexample/gbxadvancedexample.h> -@endverbatim - -@par Responsible Developer -Alex Makarenko - -*/ - -/*! -@namespace gbxadvancedexample -@brief Namespace for the advanced build system example. - -This namespace is part of a library serving as an advanced build system example. - -@see @ref gbx_library_gbxadvancedexample -*/ Modified: gearbox/trunk/src/gbxserialacfr/serial.h =================================================================== --- gearbox/trunk/src/gbxserialacfr/serial.h 2008-04-21 10:27:26 UTC (rev 115) +++ gearbox/trunk/src/gbxserialacfr/serial.h 2008-04-21 11:53:02 UTC (rev 116) @@ -52,7 +52,7 @@ int usec; }; - //! Opens a device @ref dev. + //! Opens a device @c dev. //! Throws SerialException's or LockFileException's (both derive from std::exception) on error. //! Timeouts control the various read functions below. //! A timeout value of (sec=0,usec=0) indicates 'timeouts disabled'. @@ -77,12 +77,12 @@ //! but can't set the {en|dis}abled state of timeouts. void setTimeout( const Timeout &timeout ); - //! Reads up to @ref count bytes into buffer @ref buf. + //! Reads up to @c count bytes into buffer @c buf. //! Returns the number of bytes read, or '-1' on timeout (if timeouts are enabled). //! If timeouts are not enabled, blocks till it gets something. int read(void *buf, int count); - //! Tries to read exactly @ref count bytes into @ref buf. + //! Tries to read exactly @c count bytes into @c buf. //! Returns the number of bytes read, or throws an exception. //! //! If timeouts are not enabled we might block forever, waiting for the number of bytes we want or an error. @@ -94,7 +94,7 @@ //! int readFull(void *buf, int count); - //! Reads up to @ref count bytes-1 (including @ref termchar), terminated by @ref termchar. + //! Reads up to @c count bytes-1 (including @c termchar), terminated by @c termchar. //! Returns the number of bytes read. //! After reading the data, the string will be NULL terminated. //! @@ -158,7 +158,7 @@ // GOT_DATA : data available int waitForDataOrTimeout(void); - // Opens a device @ref dev. + // Opens a device @c dev. void open(int flags=0); // Won't throw exceptions. Modified: gearbox/trunk/src/gbxsickacfr/doc.dox =================================================================== --- gearbox/trunk/src/gbxsickacfr/doc.dox 2008-04-21 10:27:26 UTC (rev 115) +++ gearbox/trunk/src/gbxsickacfr/doc.dox 2008-04-21 11:53:02 UTC (rev 116) @@ -9,10 +9,10 @@ */ /*! -@ingroup gbx_drivers_laserscanner2d +@ingroup gbx_libs @ingroup gbx_cpp @ingroup gbx_linux -@defgroup gbx_driver_laserscanner2dsickacfr LaserScanner2dSickAcfr +@defgroup gbx_library_gbxsickacfr GbxSickAcfr @brief ACFR driver for SICK laser range-finder. Drives SICK hardware, directly connected to the computer. @@ -43,14 +43,23 @@ @par Dependencies -- libIceUtil (for timing/threads/mutexes), v.3.2 or newer (latest tested 3.3b). -- libGbxSerialAcfr +- libIceUtil (for timing/threads/mutexes), v.3.2 or newer (latest tested 3.3). +- @ref gbx_library_gbxserialacfr +@par Installation + +- Finding libIceUtil + - IceUtil will be found automatically if installed in one of several standard locations. + - You can specify it's installation point with @c ICEUTIL_HOME CMake variable (or an environment variable with the same name). For example: +@verbatim +$ cmake -DICEUTIL_HOME=/home/myuser/install . +@endverbatim + @par Limitations - This is a Linux-only implementation. - It works with those serial devices which @ref gbx_library_gbxserialacfr supports. -- Currently, timestamps are generated whenever a _full_ message +- Currently, timestamps are generated whenever a @b full message arrives. This is sub-optimal, since the message may take a significant amount of time to be transmitted over the serial interface. eg. 181 samples at 38400 baud takes about 75ms. Modified: gearbox/trunk/src/gbxsickacfr/gbxiceutilacfr/store.h =================================================================== --- gearbox/trunk/src/gbxsickacfr/gbxiceutilacfr/store.h 2008-04-21 10:27:26 UTC (rev 115) +++ gearbox/trunk/src/gbxsickacfr/gbxiceutilacfr/store.h 2008-04-21 11:53:02 UTC (rev 116) @@ -26,11 +26,11 @@ * This container is similar to a circular Buffer of size one but with two * differences: * - a copy of the data is always available, yet the user knows when new - * data has arrived by calling @ref isNewData - * - @ref getNext returns the new data arrives (not when the buffer + * data has arrived by calling isNewData(). + * - getNext() returns the new data arrives (not when the buffer * is non-empty. * - * Write to it with @ref set. Read its contents with @ref get. Trying to read from + * Write to it with set(). Read its contents with get(). Trying to read from * an empty Store raises an gbxsickacfr::gbxutilacfr::Exception. * * @note Replaces the deprecated Proxy class. @@ -45,18 +45,18 @@ virtual ~Store(); //! Returns TRUE if there's something in the Store. The Store starts its life empty - //! but after the object is set once, it will be non-empty again until @ref purge is + //! but after the object is set once, it will be non-empty again until purge() is //! called. bool isEmpty() const; - //! Returns TRUE if the data in the Store has not been accessed with @ref get yet. + //! Returns TRUE if the data in the Store has not been accessed with get() yet. bool isNewData() const; //! Sets the contents of the Store. void set( const Type & obj ); //! Returns the contents of the Store. This operation makes the data in the Store - //! "not new", i.e. @ref isNewData returns FALSE. Calls to @ref get when the Store is empty + //! "not new", i.e. @ref isNewData returns FALSE. Calls to get() when the Store is empty //! raises an gbxsickacfr::gbxutilacfr::Exception exception. void get( Type & obj ) const; Copied: gearbox/trunk/src/urg_nz/doc.dox (from rev 114, gearbox/trunk/src/urg_nz/urg_nz.dox) =================================================================== --- gearbox/trunk/src/urg_nz/doc.dox (rev 0) +++ gearbox/trunk/src/urg_nz/doc.dox 2008-04-21 11:53:02 UTC (rev 116) @@ -0,0 +1,50 @@ +/*! + +@ingroup gbx_libs +@ingroup gbx_hardware +@ingroup gbx_c +@ingroup gbx_linux +@defgroup gbx_library_urg_nz liburg_nz +@brief Hokuyo URG laser scanner driver. + +For a full list of functions and classes see @ref urg_nz. + +Header file: +@verbatim +#include <urglaser/urg_laser.h> +@endverbatim + +@par Responsible Developer + Geoffrey Biggs + +@par Copyright + Toby Collett, Nico Blodow, Geoffrey Biggs + +@par License + GPL + +@par Style guidelines + +- Naming conventions: + - Class methods start with a capital letter. + - Underscores in member, variable and type names. + - \#define'd values in all capitals. +- Formatting: + - 4 space indentation. + - Function declarations on one line. + - Space between function name and arguments. +- C++ API. + - Functionality provided through classes with utility structures. +- Units: + - All internal units are in millimetres and radians. + +*/ + +/*! +@namespace urg_nz +@brief URG laser scanner driver name space. + +This namespace is part of a library which provides a driver for the URG laser scanner driver. + +@see @ref gbx_library_urg_nz +*/ Deleted: gearbox/trunk/src/urg_nz/urg_nz.dox =================================================================== --- gearbox/trunk/src/urg_nz/urg_nz.dox 2008-04-21 10:27:26 UTC (rev 115) +++ gearbox/trunk/src/urg_nz/urg_nz.dox 2008-04-21 11:53:02 UTC (rev 116) @@ -1,50 +0,0 @@ -/*! - -@ingroup gbx_libs -@ingroup gbx_hardware -@ingroup gbx_c -@ingroup gbx_linux -@defgroup gbx_library_urg_nz liburg_nz -@brief Hokuyo URG laser scanner driver. - -For a full list of functions and classes see @ref urg_nz. - -Header file: -@verbatim -#include <urglaser/urg_laser.h> -@endverbatim - -@par Responsible Developer - Geoffrey Biggs - -@par Copyright - Toby Collett, Nico Blodow, Geoffrey Biggs - -@par License - GPL - -@par Style guidelines - -- Naming conventions: - - Class methods start with a capital letter. - - Underscores in member, variable and type names. - - #define'd values in all capitals. -- Formatting: - - 4 space indentation. - - Function declarations on one line. - - Space between function name and arguments. -- C++ API. - - Functionality provided through classes with utility structures. -- Units: - - All internal units are in millimetres and radians. - -*/ - -/*! -@namespace urg_nz -@brief URG laser scanner driver name space. - -This namespace is part of a library which provides a driver for the URG laser scanner driver. - -@see @ref gbx_library_urg_nz -*/ Modified: gearbox/trunk/src/urg_nz/urg_nz.h =================================================================== --- gearbox/trunk/src/urg_nz/urg_nz.h 2008-04-21 10:27:26 UTC (rev 115) +++ gearbox/trunk/src/urg_nz/urg_nz.h 2008-04-21 11:53:02 UTC (rev 116) @@ -126,7 +126,7 @@ Supported baud rates for RS232 connections are 19200, 57600 and 115200. Baud rate is not applicable to USB connections. - @param PortName Fully-qualified path to the port the scanner is connected to. + @param port_name Fully-qualified path to the port the scanner is connected to. @param use_serial Use a serial connection. The alternative is termios. @param baud Baud rate for serial connections. */ void Open (const char *port_name, bool use_serial, int baud); This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |