From d8ae22cebd92a9ac84fcfafdf61407da5bef9bfe Mon Sep 17 00:00:00 2001 From: Houtan Bastani Date: Fri, 15 Mar 2013 17:48:46 +0100 Subject: [PATCH] reporting: cosmetic changes --- matlab/reports/@graph/createGraph.m | 4 ++-- matlab/reports/@pages/addPage.m | 17 ++++++++++++++--- matlab/reports/@pages/display.m | 2 +- matlab/reports/@pages/getPages.m | 11 +++++++++++ matlab/reports/@pages/numPages.m | 16 +++++++++++++--- matlab/reports/@pages/pages.m | 9 +++++---- matlab/reports/@pages/write.m | 5 +++-- matlab/reports/@sections/sections.m | 15 +++++++++++++-- 8 files changed, 62 insertions(+), 17 deletions(-) diff --git a/matlab/reports/@graph/createGraph.m b/matlab/reports/@graph/createGraph.m index 02cc716fc..ec9b035f7 100644 --- a/matlab/reports/@graph/createGraph.m +++ b/matlab/reports/@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/reports/@pages/addPage.m b/matlab/reports/@pages/addPage.m index e248cba7a..e5fe7e556 100644 --- a/matlab/reports/@pages/addPage.m +++ b/matlab/reports/@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 . -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/reports/@pages/display.m b/matlab/reports/@pages/display.m index 89eb1b977..a76ab637f 100644 --- a/matlab/reports/@pages/display.m +++ b/matlab/reports/@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/reports/@pages/getPages.m b/matlab/reports/@pages/getPages.m index 2fd7f7f14..4075f6f2c 100644 --- a/matlab/reports/@pages/getPages.m +++ b/matlab/reports/@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/reports/@pages/numPages.m b/matlab/reports/@pages/numPages.m index 8347e8347..303ac223e 100644 --- a/matlab/reports/@pages/numPages.m +++ b/matlab/reports/@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 . -np = ps.objArray.numObjs(); +n = o.objArray.numObjs(); end \ No newline at end of file diff --git a/matlab/reports/@pages/pages.m b/matlab/reports/@pages/pages.m index 37727eb94..78003bde6 100644 --- a/matlab/reports/@pages/pages.m +++ b/matlab/reports/@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/reports/@pages/write.m b/matlab/reports/@pages/write.m index 0c6efe5fb..c7b2c1873 100644 --- a/matlab/reports/@pages/write.m +++ b/matlab/reports/@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/reports/@sections/sections.m b/matlab/reports/@sections/sections.m index 9779751fe..00110fb64 100644 --- a/matlab/reports/@sections/sections.m +++ b/matlab/reports/@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');