Changeset 519

Show
Ignore:
Timestamp:
06/27/08 11:46:32 (6 months ago)
Author:
mgalloy
Message:

Adding warnings to DocBook? output.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/idldoc/src/templates/docbook-index.tt

    r506 r519  
    1212  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="overview.xml"/> 
    1313  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="all-dirs.xml"/>   
     14   
     15  <part><title>Other information</title> 
     16    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="idldoc-warnings.xml"/> 
     17  </part> 
    1418</book>     
    1519 

  • trunk/idldoc/src/templates/docbook-warnings.tt

    r502 r519  
     1<?xml version="1.0"?> 
     2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 
     3                 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 
     4                  
     5<chapter><title>Warnings</title> 
     6 
     7  [% IF n_todos eq 0 && n_bugs eq 0 && n_undocumented eq 0 && n_obsolete eq 0 && ~statistics && required_version eq '' %] 
     8  <para>No warnings to report.</para> 
     9  [% END %] 
     10       
     11       
     12  [% IF n_todos gt 0 %] 
     13  <sect1><title>Todos</title> 
     14     
     15    <variablelist> 
     16      [% FOREACH r IN todos %][% SCOPE r %] 
     17      <varlistentry> 
     18        <term>[% index_name %]</term> 
     19        <listitem>[% index_type %]</listitem>                    
     20      </varlistentry> 
     21        [% END %][% END %] 
     22    </variablelist> 
     23  </sect1> 
     24  [% END %] 
     25         
     26         
     27  [% IF n_bugs gt 0 %] 
     28  <sect1><title>Routines and files with noted bugs</title> 
     29   
     30    <variablelist> 
     31      [% FOREACH r IN bugs %][% SCOPE r %] 
     32      <varlistentry> 
     33        <term>[% index_name %]</term> 
     34        <listitem>[% index_type %]</listitem> 
     35      </varlistentry> 
     36      [% END %][% END %]       
     37    </variablelist> 
     38  </sect1> 
     39  [% END %] 
     40         
     41         
     42  [% IF n_undocumented gt 0 %] 
     43  <sect1><title>Routines without full documentation</title> 
     44   
     45    <variablelist> 
     46      [% FOREACH r IN undocumented %][% SCOPE r %] 
     47      <varlistentry> 
     48          <term><filename>[% location %][% basename %]</filename>: [% IF is_method %]<methodname>[% name %]</methodname>[% ELSE %]<function>[% name %]</function>[% END %]</term> 
     49           
     50          <listitem>[% IF documentation_level eq 0 %]no documentation[% ELSE %] partial documentation[% END %]</listitem>   
     51      </varlistentry>       
     52      [% END %][% END %] 
     53    </variablelist> 
     54  </sect1> 
     55  [% END %] 
     56         
     57         
     58  [% IF n_obsolete gt 0 %] 
     59  <sect1><title>Obsolete routines and files</title> 
     60     
     61    <variablelist> 
     62      [% FOREACH r IN obsolete %][% SCOPE r %] 
     63      <varlistentry> 
     64        <term>[% index_name %]</term> 
     65        <listitem>[% index_type %]</listitem> 
     66      </varlistentry> 
     67      [% END %][% END %] 
     68    </variablelist> 
     69  </sect1> 
     70  [% END %] 
     71         
     72         
     73  [% IF statistics %] 
     74  <sect1><title>Statistics</title> 
     75   
     76    <para>This section is not yet included in the output.</para> 
     77   
     78  </sect1> 
     79  [% END %] 
     80 
     81   
     82  [% IF requires_version ne '' %] 
     83  <sect1><title>Requires</title> 
     84   
     85    <para>Routines and files that require IDL [% requires_version %]: 
     86       
     87      <variablelist> 
     88        [% FOREACH r in requires_items %][% SCOPE r %] 
     89        <varlistentry> 
     90          <term>[% index_name %]</term> 
     91            <listitem>[% index_type %]</listitem> 
     92            </varlistentry> 
     93        [% END %][% END %] 
     94      </variablelist> 
     95    </para> 
     96     
     97  </sect1> 
     98  [% END %] 
     99         
     100</chapter>