changeset 11249:b9b0592d2c87 octave-forge

format doc
author abarth93
date Mon, 19 Nov 2012 21:32:45 +0000
parents cc196189bd61
children d560491bf350
files extra/cgi/DESCRIPTION extra/cgi/inst/@cgi/cgi.m extra/cgi/inst/@cgi/getlist.m extra/cgi/inst/@cgi/subsref.m
diffstat 4 files changed, 13 insertions(+), 16 deletions(-) [+]
line wrap: on
line diff
--- a/extra/cgi/DESCRIPTION	Mon Nov 19 21:24:06 2012 +0000
+++ b/extra/cgi/DESCRIPTION	Mon Nov 19 21:32:45 2012 +0000
@@ -5,7 +5,7 @@
 Maintainer: Alexander Barth <barth.alexander@gmail.com>
 Title: cgi
 Description: Common Gatway Interface for Octave
-Categories: IO
+Categories: Web development
 Depends: octave (>= 3.4.0)
 Autoload: yes
 License: GPL version 2 or later
--- a/extra/cgi/inst/@cgi/cgi.m	Mon Nov 19 21:24:06 2012 +0000
+++ b/extra/cgi/inst/@cgi/cgi.m	Mon Nov 19 21:32:45 2012 +0000
@@ -1,22 +1,17 @@
 %% -*- texinfo -*-
 %% @deftypefn {Function File} {@var{CGI} =} cgi ()
-%% Create a CGI object to parse CGI query string from GET or POST requests.
+%% Creates a CGI object to parse CGI query string from GET or POST requests.
+%% Parameter can be return by:
+%% getfirst(CGI,name[,default])
+%% getlist(CGI,name)
+%% CGI.form.name
+%%
+%% The methods getfirst and getlist behave as the Python CGI functions
 %% 
 %% @end deftypefn
 %% @seealso{getfirst,getlist}
 
 
-% 
-% CGI = cgi();
-%
-% Parameter can be return by:
-
-% getfirst(CGI,name[,default])
-% getlist(CGI,name)
-% CGI.form.name
-%
-% The methods getfirst and getlist behave as the Python CGI functions
-
 function retval = cgi()
 
 self.request_method = getenv('REQUEST_METHOD');
--- a/extra/cgi/inst/@cgi/getlist.m	Mon Nov 19 21:24:06 2012 +0000
+++ b/extra/cgi/inst/@cgi/getlist.m	Mon Nov 19 21:32:45 2012 +0000
@@ -1,7 +1,7 @@
 %% -*- texinfo -*-
 %% @deftypefn {Function File} {@var{vals} =} getlist(@var{cgi},@var{name})
-%% Returns all CGI parameters with the given @var{name}. The object @var{cgi} was 
-%% created using the cgi() constructor.
+%% Returns all CGI parameters with the given name. The object @var{cgi} was 
+%% created using the cgi() constructor. @{vals} is a cell array of strings.
 %% @end deftypefn
 %% @seealso{cgi}
 
--- a/extra/cgi/inst/@cgi/subsref.m	Mon Nov 19 21:24:06 2012 +0000
+++ b/extra/cgi/inst/@cgi/subsref.m	Mon Nov 19 21:32:45 2012 +0000
@@ -1,7 +1,9 @@
 %% -*- texinfo -*-
 %% @deftypefn {Function File} {@var{val} =} subsref(@var{cgi},@var{idx})
 %% @deftypefnx {Function File} {@var{val} =} getfirst(@var{cgi},@var{name},@var{default})
-%% Return CGI parmaters with cgi.form.name or cgi.form.('name').
+%% Dot-syntar for returning CGI parmaters
+%%
+%% This function allows to return CGI parameters with cgi.form.name or cgi.form.('name').
 %% The object @var{cgi} was 
 %% created using the cgi() constructor.
 %% @end deftypefn