From faf2d3be3f978435faa8fb6f374b210e8ab619d5 Mon Sep 17 00:00:00 2001
From: Houtan Bastani <houtan@dynare.org>
Date: Fri, 15 Mar 2013 17:48:46 +0100
Subject: [PATCH] reporting: cosmetic changes
---
matlab/reporting/@graph/createGraph.m | 4 ++--
matlab/reporting/@pages/addPage.m | 17 ++++++++++++++---
matlab/reporting/@pages/display.m | 2 +-
matlab/reporting/@pages/getPages.m | 11 +++++++++++
matlab/reporting/@pages/numPages.m | 16 +++++++++++++---
matlab/reporting/@pages/pages.m | 9 +++++----
matlab/reporting/@pages/write.m | 5 +++--
matlab/reporting/@sections/sections.m | 15 +++++++++++++--
8 files changed, 62 insertions(+), 17 deletions(-)
diff --git a/matlab/reporting/@graph/createGraph.m b/matlab/reporting/@graph/createGraph.m
index 02cc716fc1..ec9b035f77 100644
--- a/matlab/reporting/@graph/createGraph.m
+++ b/matlab/reporting/@graph/createGraph.m
@@ -81,8 +81,8 @@ if ~isempty(o.shade)
% From ShadePlotForEmpahsis (Matlab Exchange)
% use patch bc area doesn't work with matlab2tikz
- patch([repmat(x1, 1, 2) repmat(x2, 1, 2)], [yrange fliplr(yrange)], ...
- 'b', 'FaceAlpha', .2);
+ patch([repmat(x1, 1, 2) repmat(x2, 1, 2)], ...
+ [yrange fliplr(yrange)], 'b', 'FaceAlpha', .2);
end
set(gca,'XTick', x);
diff --git a/matlab/reporting/@pages/addPage.m b/matlab/reporting/@pages/addPage.m
index e248cba7a9..e5fe7e556f 100644
--- a/matlab/reporting/@pages/addPage.m
+++ b/matlab/reporting/@pages/addPage.m
@@ -1,5 +1,16 @@
-function ps = addPage(ps, varargin)
-% function ps = addPage(ps, varargin)
+function o = addPage(o, varargin)
+% function o = addPage(o, varargin)
+% Sections Class Constructor
+%
+% INPUTS
+% o [pages] pages object
+% varargin options to @page.page
+%
+% OUTPUTS
+% o [pages] pages object
+%
+% SPECIAL REQUIREMENTS
+% none
% Copyright (C) 2013 Dynare Team
%
@@ -18,5 +29,5 @@ function ps = addPage(ps, varargin)
% You should have received a copy of the GNU General Public License
% along with Dynare. If not, see <http://www.gnu.org/licenses/>.
-ps.objArray = ps.objArray.addObj(page(varargin{:}));
+o.objArray = o.objArray.addObj(page(varargin{:}));
end
\ No newline at end of file
diff --git a/matlab/reporting/@pages/display.m b/matlab/reporting/@pages/display.m
index 89eb1b9779..a76ab637f5 100644
--- a/matlab/reporting/@pages/display.m
+++ b/matlab/reporting/@pages/display.m
@@ -3,7 +3,7 @@ function display(o)
% Display a Pages object
%
% INPUTS
-% none
+% ps [pages] pages object
%
% OUTPUTS
% none
diff --git a/matlab/reporting/@pages/getPages.m b/matlab/reporting/@pages/getPages.m
index 2fd7f7f144..4075f6f2cb 100644
--- a/matlab/reporting/@pages/getPages.m
+++ b/matlab/reporting/@pages/getPages.m
@@ -1,5 +1,16 @@
function e = getPages(ps, varargin)
% function e = getPages(ps, varargin)
+% Sections Class Constructor
+%
+% INPUTS
+% ps [pages] pages object
+% varargin options to @objArray.getObjs
+%
+% OUTPUTS
+% ps [pages] array of page objects
+%
+% SPECIAL REQUIREMENTS
+% none
% Copyright (C) 2013 Dynare Team
%
diff --git a/matlab/reporting/@pages/numPages.m b/matlab/reporting/@pages/numPages.m
index 8347e83478..303ac223eb 100644
--- a/matlab/reporting/@pages/numPages.m
+++ b/matlab/reporting/@pages/numPages.m
@@ -1,5 +1,15 @@
-function np = numPages(ps)
-% function np = numPages(ps)
+function n = numPages(o)
+% function n = numPages(o)
+% Sections Class Constructor
+%
+% INPUTS
+% o [page] pages object
+%
+% OUTPUTS
+% n [integer] number of pages in o
+%
+% SPECIAL REQUIREMENTS
+% none
% Copyright (C) 2013 Dynare Team
%
@@ -18,5 +28,5 @@ function np = numPages(ps)
% You should have received a copy of the GNU General Public License
% along with Dynare. If not, see <http://www.gnu.org/licenses/>.
-np = ps.objArray.numObjs();
+n = o.objArray.numObjs();
end
\ No newline at end of file
diff --git a/matlab/reporting/@pages/pages.m b/matlab/reporting/@pages/pages.m
index 37727eb94c..78003bde60 100644
--- a/matlab/reporting/@pages/pages.m
+++ b/matlab/reporting/@pages/pages.m
@@ -3,10 +3,11 @@ function ps = pages(varargin)
% Pages Class Constructor
%
% INPUTS
-% Optional pages object
+% varargin 0 args : empty pages object
+% 1 arg : must be pages object (return a copy of arg)
%
% OUTPUTS
-% pages object
+% ps [pages] pages object
%
% SPECIAL REQUIREMENTS
% none
@@ -33,8 +34,8 @@ switch nargin
ps = class(struct, 'pages', objArray());
case 1
assert(isa(varargin{1}, 'pages'), ...
- ['@pages.pages: With one arg to pages constructor, you must ' ...
- 'pass an pages object or a char.']);
+ ['@pages.pages: With one arg to pages constructor, you must ' ...
+ 'pass an pages object or a char.']);
ps = varargin{1};
otherwise
error('@pages.pages: invalid number of arguments');
diff --git a/matlab/reporting/@pages/write.m b/matlab/reporting/@pages/write.m
index 0c6efe5fb6..c7b2c18730 100644
--- a/matlab/reporting/@pages/write.m
+++ b/matlab/reporting/@pages/write.m
@@ -3,10 +3,11 @@ function o = write(o, fid)
% Write Pages object
%
% INPUTS
-% fid - int, file id
+% o [pages] pages object
+% fid [integer] file id
%
% OUTPUTS
-% o - this
+% o [pages] pages object
%
% SPECIAL REQUIREMENTS
% none
diff --git a/matlab/reporting/@sections/sections.m b/matlab/reporting/@sections/sections.m
index 9779751fe0..00110fb640 100644
--- a/matlab/reporting/@sections/sections.m
+++ b/matlab/reporting/@sections/sections.m
@@ -1,5 +1,16 @@
function s = sections(varargin)
%function s = sections(varargin)
+% Sections Class Constructor
+%
+% INPUTS
+% varargin 0 args : empty sections object
+% 1 arg : must be sections object (return a copy of arg)
+%
+% OUTPUTS
+% ps [sections] sections object
+%
+% SPECIAL REQUIREMENTS
+% none
% Copyright (C) 2013 Dynare Team
%
@@ -22,8 +33,8 @@ switch nargin
case 0
s = class(struct, 'sections', objArray());
case 1
- assert(isa(varargin{1}, 'sections'), ['Sections constructor: the only ' ...
- 'valid arguments are sections objects']);
+ assert(isa(varargin{1}, 'sections'), ['@sections.sections: the ' ...
+ 'only valid arguments are sections objects']);
s = varargin{1};
otherwise
error('@sections.sections: invalid number of arguments');
--
GitLab