Wrap comments are now EVEN better

release/4.3a0
Andrew Melim 2012-08-28 21:44:45 +00:00
parent fe6dd197bb
commit d0a1e662a7
14 changed files with 215 additions and 104 deletions

View File

@ -330,8 +330,10 @@ void Class::comment_fragment(FileWriter& proxyFile) const
proxyFile.oss << "%" << "-------Constructors-------" << endl; proxyFile.oss << "%" << "-------Constructors-------" << endl;
BOOST_FOREACH(ArgumentList argList, constructor.args_list) BOOST_FOREACH(ArgumentList argList, constructor.args_list)
{ {
proxyFile.oss << "%" << name << "(";
int i = 0; string up_name = boost::to_upper_copy(name);
proxyFile.oss << "%" << up_name << "(";
unsigned int i = 0;
BOOST_FOREACH(const Argument& arg, argList) BOOST_FOREACH(const Argument& arg, argList)
{ {
if(i != argList.size()-1) if(i != argList.size()-1)
@ -343,13 +345,15 @@ void Class::comment_fragment(FileWriter& proxyFile) const
proxyFile.oss << ")" << endl; proxyFile.oss << ")" << endl;
} }
proxyFile.oss << "% " << "" << endl;
proxyFile.oss << "%" << "-------Methods-------" << endl; proxyFile.oss << "%" << "-------Methods-------" << endl;
BOOST_FOREACH(const Methods::value_type& name_m, methods) { BOOST_FOREACH(const Methods::value_type& name_m, methods) {
const Method& m = name_m.second; const Method& m = name_m.second;
BOOST_FOREACH(ArgumentList argList, m.argLists) BOOST_FOREACH(ArgumentList argList, m.argLists)
{ {
proxyFile.oss << "%" << m.name << "("; string up_name = boost::to_upper_copy(m.name);
int i = 0; proxyFile.oss << "%" << up_name << "(";
unsigned int i = 0;
BOOST_FOREACH(const Argument& arg, argList) BOOST_FOREACH(const Argument& arg, argList)
{ {
if(i != argList.size()-1) if(i != argList.size()-1)
@ -358,17 +362,28 @@ void Class::comment_fragment(FileWriter& proxyFile) const
proxyFile.oss << arg.type << " " << arg.name; proxyFile.oss << arg.type << " " << arg.name;
i++; i++;
} }
proxyFile.oss << ")" << endl; proxyFile.oss << ") : returns ";
}
unsigned int retCount = 0;
BOOST_FOREACH(ReturnValue rt, m.returnVals)
{
if(retCount != m.returnVals.size() - 1)
proxyFile.oss << rt.return_type(false, rt.pair) << ", ";
else
proxyFile.oss << rt.return_type(false, rt.pair) << "" << endl;
} }
} }
proxyFile.oss << "% " << "" << endl;
proxyFile.oss << "%" << "-------Static Methods-------" << endl; proxyFile.oss << "%" << "-------Static Methods-------" << endl;
BOOST_FOREACH(const StaticMethods::value_type& name_m, static_methods) { BOOST_FOREACH(const StaticMethods::value_type& name_m, static_methods) {
const StaticMethod& m = name_m.second; const StaticMethod& m = name_m.second;
BOOST_FOREACH(ArgumentList argList, m.argLists) BOOST_FOREACH(ArgumentList argList, m.argLists)
{ {
proxyFile.oss << "%" << m.name << "("; string up_name = boost::to_upper_copy(m.name);
int i = 0; proxyFile.oss << "%" << up_name << "(";
unsigned int i = 0;
BOOST_FOREACH(const Argument& arg, argList) BOOST_FOREACH(const Argument& arg, argList)
{ {
if(i != argList.size()-1) if(i != argList.size()-1)
@ -377,7 +392,16 @@ void Class::comment_fragment(FileWriter& proxyFile) const
proxyFile.oss << arg.type << " " << arg.name; proxyFile.oss << arg.type << " " << arg.name;
i++; i++;
} }
proxyFile.oss << ")" << endl; proxyFile.oss << ") : returns ";
}
unsigned int retCount = 0;
BOOST_FOREACH(ReturnValue rt, m.returnVals)
{
if(retCount != m.returnVals.size() - 1)
proxyFile.oss << rt.return_type(false, rt.pair) << ", ";
else
proxyFile.oss << rt.return_type(false, rt.pair) << "" << endl;
} }
} }

View File

@ -27,6 +27,7 @@
#include "Method.h" #include "Method.h"
#include "StaticMethod.h" #include "StaticMethod.h"
#include "TypeAttributesTable.h" #include "TypeAttributesTable.h"
#include <boost/algorithm/string.hpp>
namespace wrap { namespace wrap {

View File

@ -47,11 +47,13 @@ void Method::proxy_wrapper_fragments(FileWriter& proxyFile, FileWriter& wrapperF
proxyFile.oss << " function varargout = " << name << "(this, varargin)\n"; proxyFile.oss << " function varargout = " << name << "(this, varargin)\n";
//Comments for documentation //Comments for documentation
proxyFile.oss << " % " << name << " "; string up_name = boost::to_upper_copy(name);
proxyFile.oss << " % " << up_name << " usage:";
unsigned int argLCount = 0;
BOOST_FOREACH(ArgumentList argList, argLists) BOOST_FOREACH(ArgumentList argList, argLists)
{ {
proxyFile.oss << " " << name << "("; proxyFile.oss << " " << up_name << "(";
int i = 0; unsigned int i = 0;
BOOST_FOREACH(const Argument& arg, argList) BOOST_FOREACH(const Argument& arg, argList)
{ {
if(i != argList.size()-1) if(i != argList.size()-1)
@ -60,8 +62,23 @@ void Method::proxy_wrapper_fragments(FileWriter& proxyFile, FileWriter& wrapperF
proxyFile.oss << arg.type << " " << arg.name; proxyFile.oss << arg.type << " " << arg.name;
i++; i++;
} }
proxyFile.oss << ") : "; if(argLCount != argLists.size()-1)
proxyFile.oss << "), ";
else
proxyFile.oss << ") : returns ";
argLCount++;
} }
unsigned int retCount = 0;
BOOST_FOREACH(ReturnValue rt, returnVals)
{
if(retCount != returnVals.size() - 1)
proxyFile.oss << rt.return_type(false, rt.pair) << ", ";
else
proxyFile.oss << rt.return_type(false, rt.pair) << "" << endl;
}
proxyFile.oss << endl; proxyFile.oss << endl;
proxyFile.oss << " % " << "Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html" << endl; proxyFile.oss << " % " << "Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html" << endl;
proxyFile.oss << " % " << "" << endl; proxyFile.oss << " % " << "" << endl;
@ -69,7 +86,7 @@ void Method::proxy_wrapper_fragments(FileWriter& proxyFile, FileWriter& wrapperF
BOOST_FOREACH(ArgumentList argList, argLists) BOOST_FOREACH(ArgumentList argList, argLists)
{ {
proxyFile.oss << " % " << name << "("; proxyFile.oss << " % " << name << "(";
int i = 0; unsigned int i = 0;
BOOST_FOREACH(const Argument& arg, argList) BOOST_FOREACH(const Argument& arg, argList)
{ {
if(i != argList.size()-1) if(i != argList.size()-1)

View File

@ -47,15 +47,17 @@ void StaticMethod::proxy_wrapper_fragments(FileWriter& proxyFile, FileWriter& wr
const TypeAttributesTable& typeAttributes, const TypeAttributesTable& typeAttributes,
vector<string>& functionNames) const { vector<string>& functionNames) const {
string upperName = name; upperName[0] = std::toupper(upperName[0], std::locale()); string upperName = name; upperName[0] = std::toupper(upperName[0], std::locale());
proxyFile.oss << " function varargout = " << upperName << "(varargin)\n"; proxyFile.oss << " function varargout = " << upperName << "(varargin)\n";
//Comments for documentation //Comments for documentation
proxyFile.oss << " % " << name << " "; string up_name = boost::to_upper_copy(name);
proxyFile.oss << " % " << up_name << " usage:";
unsigned int argLCount = 0;
BOOST_FOREACH(ArgumentList argList, argLists) BOOST_FOREACH(ArgumentList argList, argLists)
{ {
proxyFile.oss << " " << name << "("; proxyFile.oss << " " << up_name << "(";
int i = 0; unsigned int i = 0;
BOOST_FOREACH(const Argument& arg, argList) BOOST_FOREACH(const Argument& arg, argList)
{ {
if(i != argList.size()-1) if(i != argList.size()-1)
@ -64,16 +66,31 @@ void StaticMethod::proxy_wrapper_fragments(FileWriter& proxyFile, FileWriter& wr
proxyFile.oss << arg.type << " " << arg.name; proxyFile.oss << arg.type << " " << arg.name;
i++; i++;
} }
proxyFile.oss << ") : "; if(argLCount != argLists.size()-1)
proxyFile.oss << "), ";
else
proxyFile.oss << ") : returns ";
argLCount++;
} }
unsigned int retCount = 0;
BOOST_FOREACH(ReturnValue rt, returnVals)
{
if(retCount != returnVals.size() - 1)
proxyFile.oss << rt.return_type(false, rt.pair) << ", ";
else
proxyFile.oss << rt.return_type(false, rt.pair) << "" << endl;
}
proxyFile.oss << endl; proxyFile.oss << endl;
proxyFile.oss << " % " << "Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html" << endl; proxyFile.oss << " % " << "Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html" << endl;
proxyFile.oss << " % " << "" << endl; proxyFile.oss << " % " << "" << endl;
proxyFile.oss << " % " << "Method Overloads" << endl; proxyFile.oss << " % " << "Usage" << endl;
BOOST_FOREACH(ArgumentList argList, argLists) BOOST_FOREACH(ArgumentList argList, argLists)
{ {
proxyFile.oss << " % " << name << "("; proxyFile.oss << " % " << up_name << "(";
int i = 0; unsigned int i = 0;
BOOST_FOREACH(const Argument& arg, argList) BOOST_FOREACH(const Argument& arg, argList)
{ {
if(i != argList.size()-1) if(i != argList.size()-1)

View File

@ -25,6 +25,7 @@
#include "Argument.h" #include "Argument.h"
#include "ReturnValue.h" #include "ReturnValue.h"
#include "TypeAttributesTable.h" #include "TypeAttributesTable.h"
#include <boost/algorithm/string.hpp>
namespace wrap { namespace wrap {

View File

@ -1,14 +1,16 @@
%-------Constructors------- %-------Constructors-------
%Point2() %POINT2()
%Point2(double x, double y) %POINT2(double x, double y)
%
%-------Methods------- %-------Methods-------
%argChar(char a) %ARGCHAR(char a) : returns void
%argUChar(unsigned char a) %ARGUCHAR(unsigned char a) : returns void
%dim() %DIM() : returns int
%returnChar() %RETURNCHAR() : returns char
%vectorConfusion() %VECTORCONFUSION() : returns VectorNotEigen
%x() %X() : returns double
%y() %Y() : returns double
%
%-------Static Methods------- %-------Static Methods-------
% %
%For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html %For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
@ -40,7 +42,8 @@ classdef Point2 < handle
function disp(obj), obj.display; end function disp(obj), obj.display; end
function varargout = argChar(this, varargin) function varargout = argChar(this, varargin)
% argChar argChar(char a) : % ARGCHAR usage: ARGCHAR(char a) : returns void
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -53,7 +56,8 @@ classdef Point2 < handle
end end
function varargout = argUChar(this, varargin) function varargout = argUChar(this, varargin)
% argUChar argUChar(unsigned char a) : % ARGUCHAR usage: ARGUCHAR(unsigned char a) : returns void
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -66,7 +70,8 @@ classdef Point2 < handle
end end
function varargout = dim(this, varargin) function varargout = dim(this, varargin)
% dim dim() : % DIM usage: DIM() : returns int
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -79,7 +84,8 @@ classdef Point2 < handle
end end
function varargout = returnChar(this, varargin) function varargout = returnChar(this, varargin)
% returnChar returnChar() : % RETURNCHAR usage: RETURNCHAR() : returns char
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -92,7 +98,8 @@ classdef Point2 < handle
end end
function varargout = vectorConfusion(this, varargin) function varargout = vectorConfusion(this, varargin)
% vectorConfusion vectorConfusion() : % VECTORCONFUSION usage: VECTORCONFUSION() : returns VectorNotEigen
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -105,7 +112,8 @@ classdef Point2 < handle
end end
function varargout = x(this, varargin) function varargout = x(this, varargin)
% x x() : % X usage: X() : returns double
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -118,7 +126,8 @@ classdef Point2 < handle
end end
function varargout = y(this, varargin) function varargout = y(this, varargin)
% y y() : % Y usage: Y() : returns double
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads

View File

@ -1,10 +1,12 @@
%-------Constructors------- %-------Constructors-------
%Point3(double x, double y, double z) %POINT3(double x, double y, double z)
%
%-------Methods------- %-------Methods-------
%norm() %NORM() : returns double
%
%-------Static Methods------- %-------Static Methods-------
%StaticFunctionRet(double z) %STATICFUNCTIONRET(double z) : returns Point3
%staticFunction() %STATICFUNCTION() : returns double
% %
%For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html %For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
classdef Point3 < handle classdef Point3 < handle
@ -33,7 +35,8 @@ classdef Point3 < handle
function disp(obj), obj.display; end function disp(obj), obj.display; end
function varargout = norm(this, varargin) function varargout = norm(this, varargin)
% norm norm() : % NORM usage: NORM() : returns double
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -49,11 +52,12 @@ classdef Point3 < handle
methods(Static = true) methods(Static = true)
function varargout = StaticFunctionRet(varargin) function varargout = StaticFunctionRet(varargin)
% StaticFunctionRet StaticFunctionRet(double z) : % STATICFUNCTIONRET usage: STATICFUNCTIONRET(double z) : returns Point3
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Usage
% StaticFunctionRet(double z) % STATICFUNCTIONRET(double z)
if length(varargin) == 1 && isa(varargin{1},'double') if length(varargin) == 1 && isa(varargin{1},'double')
varargout{1} = geometry_wrapper(15, varargin{:}); varargout{1} = geometry_wrapper(15, varargin{:});
else else
@ -62,11 +66,12 @@ classdef Point3 < handle
end end
function varargout = StaticFunction(varargin) function varargout = StaticFunction(varargin)
% staticFunction staticFunction() : % STATICFUNCTION usage: STATICFUNCTION() : returns double
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Usage
% staticFunction() % STATICFUNCTION()
if length(varargin) == 0 if length(varargin) == 0
varargout{1} = geometry_wrapper(16, varargin{:}); varargout{1} = geometry_wrapper(16, varargin{:});
else else

View File

@ -1,26 +1,28 @@
%-------Constructors------- %-------Constructors-------
%Test() %TEST()
%Test(double a, Matrix b) %TEST(double a, Matrix b)
%
%-------Methods------- %-------Methods-------
%arg_EigenConstRef(Matrix value) %ARG_EIGENCONSTREF(Matrix value) : returns void
%create_MixedPtrs() %CREATE_MIXEDPTRS() : returns pair< Test, SharedTest >
%create_ptrs() %CREATE_PTRS() : returns pair< SharedTest, SharedTest >
%print() %PRINT() : returns void
%return_Point2Ptr(bool value) %RETURN_POINT2PTR(bool value) : returns Point2
%return_Test(Test value) %RETURN_TEST(Test value) : returns Test
%return_TestPtr(Test value) %RETURN_TESTPTR(Test value) : returns Test
%return_bool(bool value) %RETURN_BOOL(bool value) : returns bool
%return_double(double value) %RETURN_DOUBLE(double value) : returns double
%return_field(Test t) %RETURN_FIELD(Test t) : returns bool
%return_int(int value) %RETURN_INT(int value) : returns int
%return_matrix1(Matrix value) %RETURN_MATRIX1(Matrix value) : returns Matrix
%return_matrix2(Matrix value) %RETURN_MATRIX2(Matrix value) : returns Matrix
%return_pair(Vector v, Matrix A) %RETURN_PAIR(Vector v, Matrix A) : returns pair< Vector, Matrix >
%return_ptrs(Test p1, Test p2) %RETURN_PTRS(Test p1, Test p2) : returns pair< SharedTest, SharedTest >
%return_size_t(size_t value) %RETURN_SIZE_T(size_t value) : returns size_t
%return_string(string value) %RETURN_STRING(string value) : returns string
%return_vector1(Vector value) %RETURN_VECTOR1(Vector value) : returns Vector
%return_vector2(Vector value) %RETURN_VECTOR2(Vector value) : returns Vector
%
%-------Static Methods------- %-------Static Methods-------
% %
%For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html %For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
@ -52,7 +54,8 @@ classdef Test < handle
function disp(obj), obj.display; end function disp(obj), obj.display; end
function varargout = arg_EigenConstRef(this, varargin) function varargout = arg_EigenConstRef(this, varargin)
% arg_EigenConstRef arg_EigenConstRef(Matrix value) : % ARG_EIGENCONSTREF usage: ARG_EIGENCONSTREF(Matrix value) : returns void
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -65,7 +68,8 @@ classdef Test < handle
end end
function varargout = create_MixedPtrs(this, varargin) function varargout = create_MixedPtrs(this, varargin)
% create_MixedPtrs create_MixedPtrs() : % CREATE_MIXEDPTRS usage: CREATE_MIXEDPTRS() : returns pair< Test, SharedTest >
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -78,7 +82,8 @@ classdef Test < handle
end end
function varargout = create_ptrs(this, varargin) function varargout = create_ptrs(this, varargin)
% create_ptrs create_ptrs() : % CREATE_PTRS usage: CREATE_PTRS() : returns pair< SharedTest, SharedTest >
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -91,7 +96,8 @@ classdef Test < handle
end end
function varargout = print(this, varargin) function varargout = print(this, varargin)
% print print() : % PRINT usage: PRINT() : returns void
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -104,7 +110,8 @@ classdef Test < handle
end end
function varargout = return_Point2Ptr(this, varargin) function varargout = return_Point2Ptr(this, varargin)
% return_Point2Ptr return_Point2Ptr(bool value) : % RETURN_POINT2PTR usage: RETURN_POINT2PTR(bool value) : returns Point2
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -117,7 +124,8 @@ classdef Test < handle
end end
function varargout = return_Test(this, varargin) function varargout = return_Test(this, varargin)
% return_Test return_Test(Test value) : % RETURN_TEST usage: RETURN_TEST(Test value) : returns Test
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -130,7 +138,8 @@ classdef Test < handle
end end
function varargout = return_TestPtr(this, varargin) function varargout = return_TestPtr(this, varargin)
% return_TestPtr return_TestPtr(Test value) : % RETURN_TESTPTR usage: RETURN_TESTPTR(Test value) : returns Test
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -143,7 +152,8 @@ classdef Test < handle
end end
function varargout = return_bool(this, varargin) function varargout = return_bool(this, varargin)
% return_bool return_bool(bool value) : % RETURN_BOOL usage: RETURN_BOOL(bool value) : returns bool
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -156,7 +166,8 @@ classdef Test < handle
end end
function varargout = return_double(this, varargin) function varargout = return_double(this, varargin)
% return_double return_double(double value) : % RETURN_DOUBLE usage: RETURN_DOUBLE(double value) : returns double
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -169,7 +180,8 @@ classdef Test < handle
end end
function varargout = return_field(this, varargin) function varargout = return_field(this, varargin)
% return_field return_field(Test t) : % RETURN_FIELD usage: RETURN_FIELD(Test t) : returns bool
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -182,7 +194,8 @@ classdef Test < handle
end end
function varargout = return_int(this, varargin) function varargout = return_int(this, varargin)
% return_int return_int(int value) : % RETURN_INT usage: RETURN_INT(int value) : returns int
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -195,7 +208,8 @@ classdef Test < handle
end end
function varargout = return_matrix1(this, varargin) function varargout = return_matrix1(this, varargin)
% return_matrix1 return_matrix1(Matrix value) : % RETURN_MATRIX1 usage: RETURN_MATRIX1(Matrix value) : returns Matrix
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -208,7 +222,8 @@ classdef Test < handle
end end
function varargout = return_matrix2(this, varargin) function varargout = return_matrix2(this, varargin)
% return_matrix2 return_matrix2(Matrix value) : % RETURN_MATRIX2 usage: RETURN_MATRIX2(Matrix value) : returns Matrix
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -221,7 +236,8 @@ classdef Test < handle
end end
function varargout = return_pair(this, varargin) function varargout = return_pair(this, varargin)
% return_pair return_pair(Vector v, Matrix A) : % RETURN_PAIR usage: RETURN_PAIR(Vector v, Matrix A) : returns pair< Vector, Matrix >
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -234,7 +250,8 @@ classdef Test < handle
end end
function varargout = return_ptrs(this, varargin) function varargout = return_ptrs(this, varargin)
% return_ptrs return_ptrs(Test p1, Test p2) : % RETURN_PTRS usage: RETURN_PTRS(Test p1, Test p2) : returns pair< SharedTest, SharedTest >
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -247,7 +264,8 @@ classdef Test < handle
end end
function varargout = return_size_t(this, varargin) function varargout = return_size_t(this, varargin)
% return_size_t return_size_t(size_t value) : % RETURN_SIZE_T usage: RETURN_SIZE_T(size_t value) : returns size_t
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -260,7 +278,8 @@ classdef Test < handle
end end
function varargout = return_string(this, varargin) function varargout = return_string(this, varargin)
% return_string return_string(string value) : % RETURN_STRING usage: RETURN_STRING(string value) : returns string
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -273,7 +292,8 @@ classdef Test < handle
end end
function varargout = return_vector1(this, varargin) function varargout = return_vector1(this, varargin)
% return_vector1 return_vector1(Vector value) : % RETURN_VECTOR1 usage: RETURN_VECTOR1(Vector value) : returns Vector
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -286,7 +306,8 @@ classdef Test < handle
end end
function varargout = return_vector2(this, varargin) function varargout = return_vector2(this, varargin)
% return_vector2 return_vector2(Vector value) : % RETURN_VECTOR2 usage: RETURN_VECTOR2(Vector value) : returns Vector
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads

View File

@ -1,6 +1,8 @@
%-------Constructors------- %-------Constructors-------
%ClassA() %CLASSA()
%
%-------Methods------- %-------Methods-------
%
%-------Static Methods------- %-------Static Methods-------
% %
%For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html %For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html

View File

@ -1,6 +1,8 @@
%-------Constructors------- %-------Constructors-------
%ClassB() %CLASSB()
%
%-------Methods------- %-------Methods-------
%
%-------Static Methods------- %-------Static Methods-------
% %
%For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html %For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html

View File

@ -1,6 +1,8 @@
%-------Constructors------- %-------Constructors-------
%ClassB() %CLASSB()
%
%-------Methods------- %-------Methods-------
%
%-------Static Methods------- %-------Static Methods-------
% %
%For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html %For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html

View File

@ -1,11 +1,13 @@
%-------Constructors------- %-------Constructors-------
%ClassA() %CLASSA()
%
%-------Methods------- %-------Methods-------
%memberFunction() %MEMBERFUNCTION() : returns double
%nsArg(ClassB arg) %NSARG(ClassB arg) : returns int
%nsReturn(double q) %NSRETURN(double q) : returns ns2::ns3::ClassB
%
%-------Static Methods------- %-------Static Methods-------
%afunction() %AFUNCTION() : returns double
% %
%For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html %For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
classdef ClassA < handle classdef ClassA < handle
@ -34,7 +36,8 @@ classdef ClassA < handle
function disp(obj), obj.display; end function disp(obj), obj.display; end
function varargout = memberFunction(this, varargin) function varargout = memberFunction(this, varargin)
% memberFunction memberFunction() : % MEMBERFUNCTION usage: MEMBERFUNCTION() : returns double
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -47,7 +50,8 @@ classdef ClassA < handle
end end
function varargout = nsArg(this, varargin) function varargout = nsArg(this, varargin)
% nsArg nsArg(ClassB arg) : % NSARG usage: NSARG(ClassB arg) : returns int
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -60,7 +64,8 @@ classdef ClassA < handle
end end
function varargout = nsReturn(this, varargin) function varargout = nsReturn(this, varargin)
% nsReturn nsReturn(double q) : % NSRETURN usage: NSRETURN(double q) : returns ns2::ns3::ClassB
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Method Overloads
@ -76,11 +81,12 @@ classdef ClassA < handle
methods(Static = true) methods(Static = true)
function varargout = Afunction(varargin) function varargout = Afunction(varargin)
% afunction afunction() : % AFUNCTION usage: AFUNCTION() : returns double
% Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html
% %
% Method Overloads % Usage
% afunction() % AFUNCTION()
if length(varargin) == 0 if length(varargin) == 0
varargout{1} = testNamespaces_wrapper(12, varargin{:}); varargout{1} = testNamespaces_wrapper(12, varargin{:});
else else

View File

@ -1,6 +1,8 @@
%-------Constructors------- %-------Constructors-------
%ClassC() %CLASSC()
%
%-------Methods------- %-------Methods-------
%
%-------Static Methods------- %-------Static Methods-------
% %
%For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html %For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html

View File

@ -1,6 +1,8 @@
%-------Constructors------- %-------Constructors-------
%ClassD() %CLASSD()
%
%-------Methods------- %-------Methods-------
%
%-------Static Methods------- %-------Static Methods-------
% %
%For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html %For more detailed documentation on GTSAM go to our Doxygen page, which can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html