Updated notes on interface
parent
ee51dfd68b
commit
ab415e0d09
2
gtsam.h
2
gtsam.h
|
|
@ -22,6 +22,7 @@
|
||||||
* - Constness has no effect
|
* - Constness has no effect
|
||||||
* 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
|
||||||
|
* - The function generated by wrap will start with an uppercase letter, regardless
|
||||||
* Arguments to functions any of
|
* Arguments to functions any of
|
||||||
* - Eigen types: Matrix, Vector
|
* - Eigen types: Matrix, Vector
|
||||||
* - Eigen types and classes as an optionally const reference
|
* - Eigen types and classes as an optionally const reference
|
||||||
|
|
@ -46,7 +47,6 @@
|
||||||
* - All namespaces must have angle brackets: <path>
|
* - All namespaces must have angle brackets: <path>
|
||||||
* - To override, add a full include statement just before the class statement
|
* - To override, add a full include statement just before the class statement
|
||||||
* - An override include can be added for a namespace by placing it just before the namespace statement
|
* - An override include can be added for a namespace by placing it just before the namespace statement
|
||||||
* - Both classes and namespace accept exactly one namespace
|
|
||||||
* Overriding type dependency checks
|
* Overriding type dependency checks
|
||||||
* - If you are using a class 'OtherClass' not wrapped in this definition file, add "class OtherClass;" to avoid a dependency error
|
* - If you are using a class 'OtherClass' not wrapped in this definition file, add "class OtherClass;" to avoid a dependency error
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue