From a6545b4e010e8c4fb946eea7da0bb13864027b2e Mon Sep 17 00:00:00 2001 From: Andrew Melim Date: Mon, 27 Aug 2012 17:54:25 +0000 Subject: [PATCH] Fixed wrap tests and changed comments --- wrap/Class.cpp | 2 +- wrap/Method.cpp | 17 ++- wrap/StaticMethod.cpp | 18 ++- wrap/tests/expected/Point2.m | 50 ++++++- wrap/tests/expected/Point3.m | 25 +++- wrap/tests/expected/Test.m | 122 +++++++++++++++++- wrap/tests/expected/aGlobalFunction.m | 1 - wrap/tests/expected/geometry_wrapper.cpp | 1 - wrap/tests/expected_namespaces/ClassD.m | 7 +- .../testNamespaces_wrapper.cpp | 1 - 10 files changed, 234 insertions(+), 10 deletions(-) diff --git a/wrap/Class.cpp b/wrap/Class.cpp index 652753cc0..44aa6a1bd 100644 --- a/wrap/Class.cpp +++ b/wrap/Class.cpp @@ -382,6 +382,6 @@ void Class::comment_fragment(FileWriter& proxyFile) const } 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 << "%" << "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" << endl; } /* ************************************************************************* */ diff --git a/wrap/Method.cpp b/wrap/Method.cpp index 60a9f00e3..5f60d6a36 100644 --- a/wrap/Method.cpp +++ b/wrap/Method.cpp @@ -47,7 +47,22 @@ void Method::proxy_wrapper_fragments(FileWriter& proxyFile, FileWriter& wrapperF proxyFile.oss << " function varargout = " << name << "(this, varargin)\n"; //Comments for documentation - proxyFile.oss << " % " << name << " See GTSAM Doxygen html for detailed info." << endl; + proxyFile.oss << " % " << name << " "; + BOOST_FOREACH(ArgumentList argList, argLists) + { + proxyFile.oss << " " << name << "("; + int i = 0; + BOOST_FOREACH(const Argument& arg, argList) + { + if(i != argList.size()-1) + proxyFile.oss << arg.type << " " << arg.name << ", "; + else + proxyFile.oss << arg.type << " " << arg.name; + i++; + } + proxyFile.oss << ") : "; + } + 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 << " % " << "" << endl; proxyFile.oss << " % " << "Method Overloads" << endl; diff --git a/wrap/StaticMethod.cpp b/wrap/StaticMethod.cpp index b2c757e96..c232739be 100644 --- a/wrap/StaticMethod.cpp +++ b/wrap/StaticMethod.cpp @@ -50,7 +50,23 @@ void StaticMethod::proxy_wrapper_fragments(FileWriter& proxyFile, FileWriter& wr string upperName = name; upperName[0] = std::toupper(upperName[0], std::locale()); proxyFile.oss << " function varargout = " << upperName << "(varargin)\n"; - proxyFile.oss << " % " << name << " See GTSAM Doxygen html for detailed info." << endl; + //Comments for documentation + proxyFile.oss << " % " << name << " "; + BOOST_FOREACH(ArgumentList argList, argLists) + { + proxyFile.oss << " " << name << "("; + int i = 0; + BOOST_FOREACH(const Argument& arg, argList) + { + if(i != argList.size()-1) + proxyFile.oss << arg.type << " " << arg.name << ", "; + else + proxyFile.oss << arg.type << " " << arg.name; + i++; + } + proxyFile.oss << ") : "; + } + 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 << " % " << "" << endl; proxyFile.oss << " % " << "Method Overloads" << endl; diff --git a/wrap/tests/expected/Point2.m b/wrap/tests/expected/Point2.m index f23e15eb4..8a2718377 100644 --- a/wrap/tests/expected/Point2.m +++ b/wrap/tests/expected/Point2.m @@ -1,4 +1,17 @@ -% automatically generated by wrap +%-------Constructors------- +%Point2() +%Point2(double x, double y) +%-------Methods------- +%argChar(char a) +%argUChar(unsigned char a) +%dim() +%returnChar() +%vectorConfusion() +%x() +%y() +%-------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 classdef Point2 < handle properties ptr_Point2 = 0 @@ -27,6 +40,11 @@ classdef Point2 < handle function disp(obj), obj.display; end function varargout = argChar(this, varargin) + % argChar argChar(char a) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % argChar(char a) if length(varargin) == 1 && isa(varargin{1},'char') geometry_wrapper(4, this, varargin{:}); else @@ -35,6 +53,11 @@ classdef Point2 < handle end function varargout = argUChar(this, varargin) + % argUChar argUChar(unsigned char a) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % argUChar(unsigned char a) if length(varargin) == 1 && isa(varargin{1},'char') geometry_wrapper(5, this, varargin{:}); else @@ -43,6 +66,11 @@ classdef Point2 < handle end function varargout = dim(this, varargin) + % dim dim() : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % dim() if length(varargin) == 0 varargout{1} = geometry_wrapper(6, this, varargin{:}); else @@ -51,6 +79,11 @@ classdef Point2 < handle end function varargout = returnChar(this, varargin) + % returnChar returnChar() : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % returnChar() if length(varargin) == 0 varargout{1} = geometry_wrapper(7, this, varargin{:}); else @@ -59,6 +92,11 @@ classdef Point2 < handle end function varargout = vectorConfusion(this, varargin) + % vectorConfusion vectorConfusion() : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % vectorConfusion() if length(varargin) == 0 varargout{1} = geometry_wrapper(8, this, varargin{:}); else @@ -67,6 +105,11 @@ classdef Point2 < handle end function varargout = x(this, varargin) + % x x() : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % x() if length(varargin) == 0 varargout{1} = geometry_wrapper(9, this, varargin{:}); else @@ -75,6 +118,11 @@ classdef Point2 < handle end function varargout = y(this, varargin) + % y y() : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % y() if length(varargin) == 0 varargout{1} = geometry_wrapper(10, this, varargin{:}); else diff --git a/wrap/tests/expected/Point3.m b/wrap/tests/expected/Point3.m index 773ebefc0..4cd50f4d5 100644 --- a/wrap/tests/expected/Point3.m +++ b/wrap/tests/expected/Point3.m @@ -1,4 +1,12 @@ -% automatically generated by wrap +%-------Constructors------- +%Point3(double x, double y, double z) +%-------Methods------- +%norm() +%-------Static Methods------- +%StaticFunctionRet(double z) +%staticFunction() +% +%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 properties ptr_Point3 = 0 @@ -25,6 +33,11 @@ classdef Point3 < handle function disp(obj), obj.display; end function varargout = norm(this, varargin) + % norm norm() : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % norm() if length(varargin) == 0 varargout{1} = geometry_wrapper(14, this, varargin{:}); else @@ -36,6 +49,11 @@ classdef Point3 < handle methods(Static = true) function varargout = StaticFunctionRet(varargin) + % StaticFunctionRet StaticFunctionRet(double z) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % StaticFunctionRet(double z) if length(varargin) == 1 && isa(varargin{1},'double') varargout{1} = geometry_wrapper(15, varargin{:}); else @@ -44,6 +62,11 @@ classdef Point3 < handle end function varargout = StaticFunction(varargin) + % staticFunction staticFunction() : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % staticFunction() if length(varargin) == 0 varargout{1} = geometry_wrapper(16, varargin{:}); else diff --git a/wrap/tests/expected/Test.m b/wrap/tests/expected/Test.m index f36c8eb30..4ce501fb0 100644 --- a/wrap/tests/expected/Test.m +++ b/wrap/tests/expected/Test.m @@ -1,4 +1,29 @@ -% automatically generated by wrap +%-------Constructors------- +%Test() +%Test(double a, Matrix b) +%-------Methods------- +%arg_EigenConstRef(Matrix value) +%create_MixedPtrs() +%create_ptrs() +%print() +%return_Point2Ptr(bool value) +%return_Test(Test value) +%return_TestPtr(Test value) +%return_bool(bool value) +%return_double(double value) +%return_field(Test t) +%return_int(int value) +%return_matrix1(Matrix value) +%return_matrix2(Matrix value) +%return_pair(Vector v, Matrix A) +%return_ptrs(Test p1, Test p2) +%return_size_t(size_t value) +%return_string(string value) +%return_vector1(Vector value) +%return_vector2(Vector value) +%-------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 classdef Test < handle properties ptr_Test = 0 @@ -27,6 +52,11 @@ classdef Test < handle function disp(obj), obj.display; end function varargout = arg_EigenConstRef(this, varargin) + % arg_EigenConstRef arg_EigenConstRef(Matrix value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % arg_EigenConstRef(Matrix value) if length(varargin) == 1 && isa(varargin{1},'double') geometry_wrapper(21, this, varargin{:}); else @@ -35,6 +65,11 @@ classdef Test < handle end function varargout = create_MixedPtrs(this, varargin) + % create_MixedPtrs create_MixedPtrs() : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % create_MixedPtrs() if length(varargin) == 0 [ varargout{1} varargout{2} ] = geometry_wrapper(22, this, varargin{:}); else @@ -43,6 +78,11 @@ classdef Test < handle end function varargout = create_ptrs(this, varargin) + % create_ptrs create_ptrs() : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % create_ptrs() if length(varargin) == 0 [ varargout{1} varargout{2} ] = geometry_wrapper(23, this, varargin{:}); else @@ -51,6 +91,11 @@ classdef Test < handle end function varargout = print(this, varargin) + % print print() : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % print() if length(varargin) == 0 geometry_wrapper(24, this, varargin{:}); else @@ -59,6 +104,11 @@ classdef Test < handle end function varargout = return_Point2Ptr(this, varargin) + % return_Point2Ptr return_Point2Ptr(bool value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_Point2Ptr(bool value) if length(varargin) == 1 && isa(varargin{1},'logical') varargout{1} = geometry_wrapper(25, this, varargin{:}); else @@ -67,6 +117,11 @@ classdef Test < handle end function varargout = return_Test(this, varargin) + % return_Test return_Test(Test value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_Test(Test value) if length(varargin) == 1 && isa(varargin{1},'Test') varargout{1} = geometry_wrapper(26, this, varargin{:}); else @@ -75,6 +130,11 @@ classdef Test < handle end function varargout = return_TestPtr(this, varargin) + % return_TestPtr return_TestPtr(Test value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_TestPtr(Test value) if length(varargin) == 1 && isa(varargin{1},'Test') varargout{1} = geometry_wrapper(27, this, varargin{:}); else @@ -83,6 +143,11 @@ classdef Test < handle end function varargout = return_bool(this, varargin) + % return_bool return_bool(bool value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_bool(bool value) if length(varargin) == 1 && isa(varargin{1},'logical') varargout{1} = geometry_wrapper(28, this, varargin{:}); else @@ -91,6 +156,11 @@ classdef Test < handle end function varargout = return_double(this, varargin) + % return_double return_double(double value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_double(double value) if length(varargin) == 1 && isa(varargin{1},'double') varargout{1} = geometry_wrapper(29, this, varargin{:}); else @@ -99,6 +169,11 @@ classdef Test < handle end function varargout = return_field(this, varargin) + % return_field return_field(Test t) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_field(Test t) if length(varargin) == 1 && isa(varargin{1},'Test') varargout{1} = geometry_wrapper(30, this, varargin{:}); else @@ -107,6 +182,11 @@ classdef Test < handle end function varargout = return_int(this, varargin) + % return_int return_int(int value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_int(int value) if length(varargin) == 1 && isa(varargin{1},'numeric') varargout{1} = geometry_wrapper(31, this, varargin{:}); else @@ -115,6 +195,11 @@ classdef Test < handle end function varargout = return_matrix1(this, varargin) + % return_matrix1 return_matrix1(Matrix value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_matrix1(Matrix value) if length(varargin) == 1 && isa(varargin{1},'double') varargout{1} = geometry_wrapper(32, this, varargin{:}); else @@ -123,6 +208,11 @@ classdef Test < handle end function varargout = return_matrix2(this, varargin) + % return_matrix2 return_matrix2(Matrix value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_matrix2(Matrix value) if length(varargin) == 1 && isa(varargin{1},'double') varargout{1} = geometry_wrapper(33, this, varargin{:}); else @@ -131,6 +221,11 @@ classdef Test < handle end function varargout = return_pair(this, varargin) + % return_pair return_pair(Vector v, Matrix A) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_pair(Vector v, Matrix A) if length(varargin) == 2 && isa(varargin{1},'double') && isa(varargin{2},'double') [ varargout{1} varargout{2} ] = geometry_wrapper(34, this, varargin{:}); else @@ -139,6 +234,11 @@ classdef Test < handle end function varargout = return_ptrs(this, varargin) + % return_ptrs return_ptrs(Test p1, Test p2) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_ptrs(Test p1, Test p2) if length(varargin) == 2 && isa(varargin{1},'Test') && isa(varargin{2},'Test') [ varargout{1} varargout{2} ] = geometry_wrapper(35, this, varargin{:}); else @@ -147,6 +247,11 @@ classdef Test < handle end function varargout = return_size_t(this, varargin) + % return_size_t return_size_t(size_t value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_size_t(size_t value) if length(varargin) == 1 && isa(varargin{1},'numeric') varargout{1} = geometry_wrapper(36, this, varargin{:}); else @@ -155,6 +260,11 @@ classdef Test < handle end function varargout = return_string(this, varargin) + % return_string return_string(string value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_string(string value) if length(varargin) == 1 && isa(varargin{1},'char') varargout{1} = geometry_wrapper(37, this, varargin{:}); else @@ -163,6 +273,11 @@ classdef Test < handle end function varargout = return_vector1(this, varargin) + % return_vector1 return_vector1(Vector value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_vector1(Vector value) if length(varargin) == 1 && isa(varargin{1},'double') varargout{1} = geometry_wrapper(38, this, varargin{:}); else @@ -171,6 +286,11 @@ classdef Test < handle end function varargout = return_vector2(this, varargin) + % return_vector2 return_vector2(Vector value) : + % Doxygen can be found at http://research.cc.gatech.edu/borg/sites/edu.borg/html/index.html + % + % Method Overloads + % return_vector2(Vector value) if length(varargin) == 1 && isa(varargin{1},'double') varargout{1} = geometry_wrapper(39, this, varargin{:}); else diff --git a/wrap/tests/expected/aGlobalFunction.m b/wrap/tests/expected/aGlobalFunction.m index 80d6b1f6b..cee69491c 100644 --- a/wrap/tests/expected/aGlobalFunction.m +++ b/wrap/tests/expected/aGlobalFunction.m @@ -1,4 +1,3 @@ -% automatically generated by wrap function varargout = aGlobalFunction(varargin) if length(varargin) == 0 varargout{1} = geometry_wrapper(40, varargin{:}); diff --git a/wrap/tests/expected/geometry_wrapper.cpp b/wrap/tests/expected/geometry_wrapper.cpp index 443795e5e..ad1df801c 100644 --- a/wrap/tests/expected/geometry_wrapper.cpp +++ b/wrap/tests/expected/geometry_wrapper.cpp @@ -1,4 +1,3 @@ -// automatically generated by wrap #include #include #include diff --git a/wrap/tests/expected_namespaces/ClassD.m b/wrap/tests/expected_namespaces/ClassD.m index 3fb8d4837..98a4df3a6 100644 --- a/wrap/tests/expected_namespaces/ClassD.m +++ b/wrap/tests/expected_namespaces/ClassD.m @@ -1,4 +1,9 @@ -% automatically generated by wrap +%-------Constructors------- +%ClassD() +%-------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 classdef ClassD < handle properties ptr_ClassD = 0 diff --git a/wrap/tests/expected_namespaces/testNamespaces_wrapper.cpp b/wrap/tests/expected_namespaces/testNamespaces_wrapper.cpp index 1a31c4b90..29739a2f6 100644 --- a/wrap/tests/expected_namespaces/testNamespaces_wrapper.cpp +++ b/wrap/tests/expected_namespaces/testNamespaces_wrapper.cpp @@ -1,4 +1,3 @@ -// automatically generated by wrap #include #include #include