Changeset 82277 in spip-zone


Ignore:
Timestamp:
May 9, 2014, 10:42:19 AM (5 years ago)
Author:
marcimat@…
Message:

Quelques corrections :

  • prises en compte des constantes dans les @uses et de leurs affichages
  • pas d'affichage intempestif du tag @todo sur les classes
Location:
_galaxie_/code.spip.net/autodoc/trunk
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • _galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Plugin/Core/Compiler/Pass/UsedByTagBuilder.php

    r75131 r82277  
    3131    /** @var ProjectDescriptor */
    3232    private $project;
    33    
     33
    3434    /** @var bool Est-ce un projet SPIP */
    3535    private $is_spip;
     
    6969                    foreach ($file->$get() as $class) {
    7070                        $this->$call($class, $file);
    71                        
     71
    7272                        foreach ($class->getMethods() as $method) {
    7373                            $this->$call($method, $file);
     
    8989     *
    9090     * @param DescriptorAbstract $element
    91      * @param FileDescriptor $file 
     91     * @param FileDescriptor $file
    9292    **/
    9393    private function findElementReferences(DescriptorAbstract $element, FileDescriptor $file) {
     
    115115
    116116    /**
    117      * Ajouter les @used-by 
    118      *
    119      * @param DescriptorAbstract $element
    120      * @param FileDescriptor $file 
     117     * Ajouter les @used-by
     118     *
     119     * @param DescriptorAbstract $element
     120     * @param FileDescriptor $file
    121121    **/
    122122    private function generateUsedByTags(DescriptorAbstract $element, FileDescriptor $file) {
     
    135135     * Corriger les références de @see manquantes
    136136     *
    137      * @param Collection $tags 
     137     * @param Collection $tags
    138138     * @param DescriptorAbstract $element
    139139     * @param FileDescriptor $file
     
    183183        }
    184184
    185         // cas 4) ça fait référence à un fichier relatif au plugin en cours
     185        // cas 4) ça fait référence à une constante
     186        if ($ref = $elements->get('\\\\' . $reference)) {
     187            $tag->setReference($ref);
     188            return true;
     189        }
     190
     191        // cas 5) ça fait référence à un fichier relatif au plugin en cours
    186192        // alors qu'on est en train de documenter un spip complet…
    187193        $path = $file->getPath();
     
    219225     * Définir un tag @used-by sur la référence, pointant sur l'élément.
    220226     *
    221      * @param Collection $uses 
     227     * @param Collection $uses
    222228     * @param DescriptorAbstract $element
    223229     * @param FileDescriptor $file
  • _galaxie_/code.spip.net/autodoc/trunk/templates/zora/content/class.twig

    r74883 r82277  
    1010
    1111<h1>{{ titre_page|raw }}</h1>
    12 
    1312
    1413{% include "inclure/descriptions/summary.twig" %}
     
    3029                with {'properties':  node.properties|trier('name')}
    3130        %}
    32 
    3331{% endif %}
    3432
  • _galaxie_/code.spip.net/autodoc/trunk/templates/zora/inclure/descriptions/constants.twig

    r75197 r82277  
    4848                                        </div><!-- .return.coloration -->
    4949
     50                                        {% set tags_principaux = [
     51                                                {'name':'example',         'inclure': 'tags',     'titre':'Exemples'},
     52                                                {'name':'link',            'inclure': 'tags',     'titre':'Documentation externe'},
     53                                                {'name':'see',             'inclure': 'see',      'titre':'Voir également'},
     54                                                {'name':'uses',            'inclure': 'see',      'titre':'Utilise'},
     55                                                {'name':'used-by',         'inclure': 'see',      'titre':'Utilisé par'},
     56                                                {'name':'pipeline',        'inclure': 'pipeline', 'titre':'Traversée par le pipeline'},
     57                                                {'name':'pipeline_appel',  'inclure': 'pipeline', 'titre':'Appelle le pipeline'},
     58                                                {'name':'global',          'inclure': 'tags',     'titre':'Variables globales'},
     59                                        ] %}
    5060
    51                                         {% for tagName,tags in constant.tags if tagName not in ['var'] %}
     61                                        {% for t in tags_principaux %}
     62                                                {% set tags = attribute(constant.tags, t.name ) %}
     63                                                {% if tags and tags.count %}
     64                                                        {% include "inclure/descriptions/" ~ t.inclure ~ ".twig"
     65                                                                with {
     66                                                                        'titre': t.titre,
     67                                                                        'tags': tags,
     68                                                                        'name': t.name
     69                                                                        }
     70                                                        %}
     71                                                {% endif %}
     72                                        {% endfor %}
     73
     74
     75                                        {% for tagName,tags in constant.tags if tagName not in [
     76                                                'param', 'return',
     77                                                'api', 'example',
     78                                                'link', 'see', 'uses', 'used-by',
     79                                                'pipeline', 'pipeline_appel',
     80                                                'global',
     81                                                'var'
     82                                        ] %}
    5283                                                {% include "inclure/descriptions/tags.twig"
    5384                                                with {
  • _galaxie_/code.spip.net/autodoc/trunk/templates/zora/inclure/descriptions/summary.twig

    r74717 r82277  
    1010{% endif %}
    1111
     12
    1213{% if node.tags.count %}
    1314        {% for tagName,tags in node.tags if tagName not in ['subpackage'] %}
     15
    1416                {# package et subpackage sont tout le temps présents, même sans phpdoc #}
    1517                {% if (tagName not in ['package', 'subpackage']) or tagName.description %}
    16                 <div class='partie autres coloration {{ tagName }}'>
    17                         <h3>{{ tagName|title }}</h3>
    18                         <ul class='liste'>
    19                                 <li class='item'>
    20                                 {%- for tag in tags %}
    21                                         {%- if tag.description %}
    22                                                 <div class="description">
    23                                                         {{ tag.description|markdown|raw }}
    24                                                 </div>
    25                                         {% endif -%}
    26                                 {% endfor -%}
    27                                 </li>
    28                         </ul>
    29                 </div><!-- .autres.coloration -->
     18
     19                {# parfois un todo vide est présent sur les classes… étonnant #}
     20                {% if (tagName not in ['todo']) or tags.count %}
     21                        <div class='partie autres coloration {{ tagName }}'>
     22                                <h3>{{ tagName|title }}</h3>
     23
     24                                {% if tags.count %}
     25                                        <ul class='liste'>
     26                                                <li class='item'>
     27                                                {%- for tag in tags %}
     28                                                        {%- if tag.description %}
     29                                                                <div class="description">
     30                                                                        {{ tag.description|markdown|raw }}
     31                                                                </div>
     32                                                        {% endif -%}
     33                                                {% endfor -%}
     34                                                </li>
     35                                        </ul>
     36                                {% endif %}
     37                        </div><!-- .autres.coloration -->
     38                {% endif %}
    3039                {% endif %}
    3140        {% endfor %}
Note: See TracChangeset for help on using the changeset viewer.