12345qiupeng
/
gtsam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added documentation on namespaces to gtsam.h

release/4.3a0
Alex Cunningham 2011-12-08 20:58:06 +00:00
parent ead8247bd7
commit d745c85f13
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
gtsam.h
View File

@ -20,6 +20,15 @@
* - Any class with which be copied with boost::make_shared() (except Eigen) * - Any class with which be copied with boost::make_shared() (except Eigen)
* - boost::shared_ptr of any object type (except Eigen) * - boost::shared_ptr of any object type (except Eigen)
* Comments can use either C++ or C style, with multiple lines * Comments can use either C++ or C style, with multiple lines
* Namespace definitions
* - Names of namespaces must start with a lowercase letter
* - start a namespace with "namespace {"
* - end a namespace with exactly "}///\namespace [namespace_name]", optionally adding the name of the namespace
* - This ending is not C++ standard, and must contain "}///\namespace" to parse
* - Namespaces can be nested
* Namespace usage
* - Namespaces can be specified for classes in arguments and return values
* - In each case, the namespace must be fully specified, e.g., "namespace1::namespace2::ClassName"
* Methods must start with a lowercase letter * Methods must start with a lowercase letter
* Static methods must start with a letter (upper or lowercase) and use the "static" keyword * Static methods must start with a letter (upper or lowercase) and use the "static" keyword
*/ */
@ -30,7 +39,6 @@
* - TODO: default values for arguments * - TODO: default values for arguments
* - TODO: overloaded functions * - TODO: overloaded functions
* - TODO: Handle Rot3M conversions to quaternions * - TODO: Handle Rot3M conversions to quaternions
* - TODO: namespace detection to handle nested namespaces
*/ */
class Point2 { class Point2 {