generic-library/opencv
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated documentation formatting

Browse Source
This commit is contained in:
hbristow 2013-08-08 03:51:44 +10:00
parent 059d63cceb
commit fad7b35b9a
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
modules/matlab/generator/templates/template_doc_base.m
View File

@ -6,9 +6,9 @@
{{ doc.long | stripTags | qualify(fun.name) | comment(75, '% ') }} {{ doc.long | stripTags | qualify(fun.name) | comment(75, '% ') }}
{% endif %} {% endif %}
% %
{# ----------------------- Returns --------------------- #}
{% if fun.rtp|void|not or fun.req|outputs|length or fun.opt|outputs|length %} {% if fun.rtp|void|not or fun.req|outputs|length or fun.opt|outputs|length %}
% Returns: % Returns:
{% endif %}
{% if fun.rtp|void|not %} {% if fun.rtp|void|not %}
% LVALUE % LVALUE
{% endif %} {% endif %}
@ -21,21 +21,22 @@
{% endif %} {% endif %}
{% endfor %} {% endfor %}
% %
{% endif %}
{# ----------------- Required Inputs ------------------- #}
{% if fun.req|inputs|length %} {% if fun.req|inputs|length %}
% Required Inputs: % Required Inputs:
{% endif %}
{% for arg in fun.req|inputs %} {% for arg in fun.req|inputs %}
{% set uname = arg.name | upper + ('_IN' if arg.O else '') %} {% set uname = arg.name | upper + ('_IN' if arg.O else '') %}
{% if arg.name in doc.params %} {% if arg.name in doc.params %}
{{ (uname + ' ' + doc.params[arg.name]) | stripTags | comment(75, '% ') }} {{ (uname + ' ' + doc.params[arg.name]) | stripTags | comment(75, '% ') }}
{% else %} {% else %}
{{ uname }}
{% endif %} {% endif %}
{% endfor %} {% endfor %}
% %
{% endif %}
{# ------------------ Optional Inputs ------------------- #}
{% if fun.opt|inputs|length %} {% if fun.opt|inputs|length %}
% Optional Inputs: % Optional Inputs:
{% endif %}
{% for arg in fun.opt|inputs %} {% for arg in fun.opt|inputs %}
{% set uname = arg.name | upper + ('_IN' if arg.O else '') + ' (default: ' + arg.default + ')' %} {% set uname = arg.name | upper + ('_IN' if arg.O else '') + ' (default: ' + arg.default + ')' %}
{% if arg.name in doc.params %} {% if arg.name in doc.params %}
@ -45,6 +46,8 @@
{% endif %} {% endif %}
{% endfor %} {% endfor %}
% %
{% endif %}
{# ---------------------- See also --------------------- #}
{% if 'seealso' in doc %} {% if 'seealso' in doc %}
% See also: {% for item in doc['seealso'] %} % See also: {% for item in doc['seealso'] %}
cv.{{ item }}{% if not loop.last %}, {% endif %} cv.{{ item }}{% if not loop.last %}, {% endif %}
@ -52,6 +55,7 @@ cv.{{ item }}{% if not loop.last %}, {% endif %}
% %
{% endif %} {% endif %}
{# ----------------------- Online ---------------------- #}
{% set url = 'http://docs.opencv.org/modules/' + doc.module + '/doc/' + (doc.file|filename) + '.html#' + (fun.name|slugify) %} {% set url = 'http://docs.opencv.org/modules/' + doc.module + '/doc/' + (doc.file|filename) + '.html#' + (fun.name|slugify) %}
% Online docs: <a href="matlab: web('{{url}}', '-browser')">{{url}}</a> % Online docs: <a href="matlab: web('{{url}}', '-browser')">{{url}}</a>
% Copyright {{ time.strftime("%Y", time.localtime()) }} The OpenCV Foundation % Copyright {{ time.strftime("%Y", time.localtime()) }} The OpenCV Foundation