From 2230380a352be27f00d26a929aeee24fab27b8b6 Mon Sep 17 00:00:00 2001
From: Houtan Bastani <houtan@dynare.org>
Date: Wed, 13 Mar 2013 18:02:29 +0100
Subject: [PATCH] reporting: code cleanup
---
matlab/reporting/@graph/createGraph.m | 4 +--
matlab/reporting/@graph/display.m | 2 +-
matlab/reporting/@graph/graph.m | 8 +++--
matlab/reporting/@graph/write.m | 5 ++--
matlab/reporting/@pages/addPage.m | 6 ----
matlab/reporting/@report/addGraph.m | 8 ++---
matlab/reporting/@report/addPage.m | 29 ++++---------------
matlab/reporting/@report/addSection.m | 8 ++---
matlab/reporting/@report/addTable.m | 8 ++---
matlab/reporting/@report/display.m | 2 +-
matlab/reporting/@report/numPages.m | 10 +++----
.../@report/private/validateOrientation.m | 7 +++--
.../reporting/@report/private/validatePaper.m | 4 +--
matlab/reporting/@report/report.m | 7 +++--
matlab/reporting/@report/write.m | 4 +--
15 files changed, 47 insertions(+), 65 deletions(-)
diff --git a/matlab/reporting/@graph/createGraph.m b/matlab/reporting/@graph/createGraph.m
index d2c663db25..9874ca78f9 100644
--- a/matlab/reporting/@graph/createGraph.m
+++ b/matlab/reporting/@graph/createGraph.m
@@ -3,10 +3,10 @@ function o = createGraph(o)
% Create the graph
%
% INPUTS
-% o - Graph Object
+% o [graph] graph object
%
% OUTPUTS
-% o - Graph Object
+% o [graph] graph object
%
% SPECIAL REQUIREMENTS
% none
diff --git a/matlab/reporting/@graph/display.m b/matlab/reporting/@graph/display.m
index 71c2b2ea25..7938abb45b 100644
--- a/matlab/reporting/@graph/display.m
+++ b/matlab/reporting/@graph/display.m
@@ -3,7 +3,7 @@ function display(o)
% Display a Graph object
%
% INPUTS
-% none
+% o [graph] graph object
%
% OUTPUTS
% none
diff --git a/matlab/reporting/@graph/graph.m b/matlab/reporting/@graph/graph.m
index b8a73374e4..1836ac9c3c 100644
--- a/matlab/reporting/@graph/graph.m
+++ b/matlab/reporting/@graph/graph.m
@@ -3,11 +3,13 @@ function o = graph(varargin)
% Graph Class Constructor
%
% INPUTS
-% 0 args => empty graph
-% 1 arg (graph class) => copy object
+% varargin 0 args : empty graph object
+% 1 arg : must be graph object (return a copy of arg)
+% > 1 args: option/value pairs (see structure below for
+% options)
%
% OUTPUTS
-% none
+% o [graph] graph object
%
% SPECIAL REQUIREMENTS
% none
diff --git a/matlab/reporting/@graph/write.m b/matlab/reporting/@graph/write.m
index aecf8ab08d..7eb10c7312 100644
--- a/matlab/reporting/@graph/write.m
+++ b/matlab/reporting/@graph/write.m
@@ -3,10 +3,11 @@ function o = write(o, fid)
% Write a Graph object
%
% INPUTS
-% fid - int, file id
+% o [graph] graph object
+% fid [integer] file id
%
% OUTPUTS
-% o - this
+% o [graph] graph object
%
% SPECIAL REQUIREMENTS
% none
diff --git a/matlab/reporting/@pages/addPage.m b/matlab/reporting/@pages/addPage.m
index 174d39b23d..e248cba7a9 100644
--- a/matlab/reporting/@pages/addPage.m
+++ b/matlab/reporting/@pages/addPage.m
@@ -19,10 +19,4 @@ function ps = addPage(ps, varargin)
% along with Dynare. If not, see <http://www.gnu.org/licenses/>.
ps.objArray = ps.objArray.addObj(page(varargin{:}));
-%assert(nargin >= 1 && nargin <= 3)
-%if nargin == 1
-% ps.objArray = ps.objArray.addObj(page());
-%else
-% ps.objArray = ps.objArray.addObj(varargin{:});
-%end
end
\ No newline at end of file
diff --git a/matlab/reporting/@report/addGraph.m b/matlab/reporting/@report/addGraph.m
index 37ced6625c..a9b247b32a 100644
--- a/matlab/reporting/@report/addGraph.m
+++ b/matlab/reporting/@report/addGraph.m
@@ -1,13 +1,13 @@
function o = addGraph(o, varargin)
%function o = addGraph(o, varargin)
-% Add a section to the current page in the current report
+% Add a graph to the current section of the current page in the report
%
% INPUTS
-% o - report object
-% varargin - arguments to @section/addGraph.m
+% o [report] report object
+% varargin arguments to @section/addGraph.m
%
% OUTPUTS
-% o - updated report object
+% o [report] updated report object
%
% SPECIAL REQUIREMENTS
% none
diff --git a/matlab/reporting/@report/addPage.m b/matlab/reporting/@report/addPage.m
index f5f2c2468f..0f65bead4f 100644
--- a/matlab/reporting/@report/addPage.m
+++ b/matlab/reporting/@report/addPage.m
@@ -1,14 +1,13 @@
function o = addPage(o, varargin)
%function o = addPage(o, varargin)
-% Add a page to the Cell Array of pages in the report
+% Add a page to the report
%
% INPUTS
-% 1 args => add empty page
-% 2 args => add given page
-% 3 args => add page at index
+% o [report] report object
+% varargin arguments to @section/addGraph.m
%
% OUTPUTS
-% updated report object
+% o [report] updated report object
%
% SPECIAL REQUIREMENTS
% none
@@ -30,22 +29,6 @@ function o = addPage(o, varargin)
% You should have received a copy of the GNU General Public License
% along with Dynare. If not, see <http://www.gnu.org/licenses/>.
-%assert(nargin >= 1 && nargin <= 3, ['incorrect number of arguments passed ' ...
-% 'to addPage']);
-%assert(isa(r, 'report'), 'First argument must be a report object');
-%if nargin > 1
-% assert(isa(varargin{1},'page'), ['Optional 2nd arg to addPage must be a ' ...
-% 'Page']);
-% if nargin > 2
-% assert(isnumeric(varargin{2}), ['Optional 3rd arg to addPage must be ' ...
-% 'an index']);
-% end
-%end
-
-if nargin == 1
- o.pages = o.pages.addPage('orientation', o.orientation, 'paper', o.paper);
-else
- o.pages = o.pages.addPage('orientation', o.orientation, 'paper', ...
- o.paper, varargin{:});
-end
+o.pages = o.pages.addPage('orientation', o.orientation, 'paper', o.paper, ...
+ varargin{:});
end
diff --git a/matlab/reporting/@report/addSection.m b/matlab/reporting/@report/addSection.m
index fabc7a191b..a0667a5ec2 100644
--- a/matlab/reporting/@report/addSection.m
+++ b/matlab/reporting/@report/addSection.m
@@ -1,13 +1,13 @@
function o = addSection(o, varargin)
%function o = addSection(o, varargin)
-% Add a section to the current page in the current report
+% Add a section to the current page in the report
%
% INPUTS
-% o - report object
-% varargin - arguments to @page/addSection.m
+% o [report] report object
+% varargin arguments to @section/addGraph.m
%
% OUTPUTS
-% o - updated report object
+% o [report] updated report object
%
% SPECIAL REQUIREMENTS
% none
diff --git a/matlab/reporting/@report/addTable.m b/matlab/reporting/@report/addTable.m
index 7257aa5ac1..15199b4bd6 100644
--- a/matlab/reporting/@report/addTable.m
+++ b/matlab/reporting/@report/addTable.m
@@ -1,13 +1,13 @@
function o = addTable(o, varargin)
%function o = addTable(o, varargin)
-% Add a section to the current page in the current report
+% Add a table to the current section of the current page in the report
%
% INPUTS
-% o - report object
-% varargin - arguments to @section/addTable.m
+% o [report] report object
+% varargin arguments to @section/addTable.m
%
% OUTPUTS
-% o - updated report object
+% o [report] updated report object
%
% SPECIAL REQUIREMENTS
% none
diff --git a/matlab/reporting/@report/display.m b/matlab/reporting/@report/display.m
index 5c1f471481..60c3f11f4a 100644
--- a/matlab/reporting/@report/display.m
+++ b/matlab/reporting/@report/display.m
@@ -3,7 +3,7 @@ function display(o)
% Display a Report object
%
% INPUTS
-% none
+% o [report] report object
%
% OUTPUTS
% none
diff --git a/matlab/reporting/@report/numPages.m b/matlab/reporting/@report/numPages.m
index 27bc12ed0d..5863c55e1d 100644
--- a/matlab/reporting/@report/numPages.m
+++ b/matlab/reporting/@report/numPages.m
@@ -1,12 +1,12 @@
-function np = numPages(r)
-%function np = numPages(r)
+function n = numPages(o)
+%function n = numPages(o)
% return the number of pages currently in the report
%
% INPUTS
-% none
+% o [report] report object
%
% OUTPUTS
-% none
+% n [integer] number of pages in the report object
%
% SPECIAL REQUIREMENTS
% none
@@ -28,5 +28,5 @@ function np = numPages(r)
% You should have received a copy of the GNU General Public License
% along with Dynare. If not, see <http://www.gnu.org/licenses/>.
-np = r.pages.numPages();
+n = o.pages.numPages();
end
\ No newline at end of file
diff --git a/matlab/reporting/@report/private/validateOrientation.m b/matlab/reporting/@report/private/validateOrientation.m
index 98683c36cc..41bf58eed1 100644
--- a/matlab/reporting/@report/private/validateOrientation.m
+++ b/matlab/reporting/@report/private/validateOrientation.m
@@ -3,10 +3,10 @@ function validateOrientation(orientation)
% Validate orientation string
%
% INPUTS
-% char : the orientation
+% orientation [char] orientation (one of 'portrait' or 'landscape')
%
% OUTPUTS
-% char : lowercase orientation
+% none
%
% SPECIAL REQUIREMENTS
% none
@@ -29,5 +29,6 @@ function validateOrientation(orientation)
% along with Dynare. If not, see <http://www.gnu.org/licenses/>.
assert(any(strcmpi(orientation, {'portrait', 'landscape'})), ['Valid ' ...
- 'orientation arguments are: ''portrait'' and ''landscape''.']);
+ 'orientation arguments are: ''portrait'' and ' ...
+ '''landscape''.']);
end
\ No newline at end of file
diff --git a/matlab/reporting/@report/private/validatePaper.m b/matlab/reporting/@report/private/validatePaper.m
index 0395db76f3..73b6bb367d 100644
--- a/matlab/reporting/@report/private/validatePaper.m
+++ b/matlab/reporting/@report/private/validatePaper.m
@@ -3,10 +3,10 @@ function validatePaper(paper)
% Validate paper string
%
% INPUTS
-% char : paper size
+% paper [char] valid LaTeX paper type
%
% OUTPUTS
-% char : lowercase paper
+% none
%
% SPECIAL REQUIREMENTS
% none
diff --git a/matlab/reporting/@report/report.m b/matlab/reporting/@report/report.m
index 77f3faa909..62cedefbb5 100644
--- a/matlab/reporting/@report/report.m
+++ b/matlab/reporting/@report/report.m
@@ -3,11 +3,12 @@ function o = report(varargin)
% Report Class Constructor
%
% INPUTS
-% 1 report class object => make a copy
-% Otherwise, option/value pairs (see structure below for options)
+% varargin 0 args : empty report object
+% 1 arg : must be report object (return a copy of arg)
+% > 1 args: option/value pairs (see structure below for options)
%
% OUTPUTS
-% none
+% o [report] report object
%
% SPECIAL REQUIREMENTS
% none
diff --git a/matlab/reporting/@report/write.m b/matlab/reporting/@report/write.m
index 21496e2e99..39b965f19c 100644
--- a/matlab/reporting/@report/write.m
+++ b/matlab/reporting/@report/write.m
@@ -3,10 +3,10 @@ function o = write(o)
% Write Report object
%
% INPUTS
-% o - Report Object
+% o [report] report object
%
% OUTPUTS
-% o - Report Object
+% o [report] report object
%
% SPECIAL REQUIREMENTS
% none
--
GitLab