Changeset 74891 in spip-zone


Ignore:
Timestamp:
Aug 22, 2013, 11:29:42 PM (6 years ago)
Author:
marcimat@…
Message:

Pouvoir déterminer quels sont les fonctions dont les tags SPIP (@balise, ...) sont absents du phpDoc et créés automatiquement par phpDocumentor et notre plugin.

Ajout d'un mode de debug mal nommé pour rendre visuel ces tags en question, en ajoutant dans l'url ?debug=1 ou en console $.autodoc.debug(true)

Location:
_galaxie_/code.spip.net/autodoc/trunk
Files:
1 added
5 edited

Legend:

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

    r74886 r74891  
    1111use phpDocumentor\Descriptor\DescriptorAbstract;
    1212use phpDocumentor\Descriptor\ProjectDescriptor;
    13 use phpDocumentor\Descriptor\TagDescriptor;
     13use autodoc\Plugin\Core\Descriptor\SpipTagDescriptor;
    1414
    1515use Cilex\Application;
     
    141141    private function addSpipTag(DescriptorAbstract $element, $tagName, $description="") {
    142142
    143         $tag = new TagDescriptor($tagName);
     143        $tag = new SpipTagDescriptor($tagName);
    144144        $tag->setDescription($description);
     145
     146        // indiquer que ce tag est ajouté de façon automatique
     147        // ce qui permet dans twig / html / css de voir qu'elles fonctions
     148        // n'ont pas le tag déclaré
     149        $tag->setWasMissing(true);
    145150
    146151        // ce tag n'existe pas encore
  • _galaxie_/code.spip.net/autodoc/trunk/templates/zora/content/sommaire.twig

    r74723 r74891  
    1919</section>
    2020
     21{% set elements = [
     22        {'type': 'balise',   'nom': 'Balises',   'elements': project.indexes.spip.balises},
     23        {'type': 'filtre',   'nom': 'Filtres',   'elements': project.indexes.spip.filtres},
     24        {'type': 'critere',  'nom': 'Critères',  'elements': project.indexes.spip.criteres},
     25        {'type': 'boucle',   'nom': 'Boucles',   'elements': project.indexes.spip.boucles},
     26        {'type': 'pipeline', 'nom': 'Pipelines', 'elements': project.indexes.spip.pipelines},
     27] %}
    2128
     29{% for e in elements %}
     30        {% if e.elements|length %}
     31                <div id="{{ e.type }}">
     32                        <h3>{{ e.nom }}</h3>
     33                        <ul class='colonnes'>
     34                                {% for function in e.elements|trier('name') %}
     35                                        {% if not function.tags['deprecated'].count %}
     36                                                <li
     37                                                        {{- function.tags[e.type].0.wasMissing ? " class='was_missing' " : '' -}}
     38                                                ><a href="{{ path( function ) }}">{{ function.tags[e.type].0.description }}</a></li>
     39                                        {% endif %}
     40                                {% endfor %}
     41                        </ul>
     42                </div><!-- #{{ e.type }} -->
     43        {% endif %}
     44{% endfor %}
  • _galaxie_/code.spip.net/autodoc/trunk/templates/zora/css/perso.css

    r74730 r74891  
    289289table.statistiques th.total { min-width:50px; width:20%; }
    290290
     291/* [autodoc] debug */
     292table tr.debug td,
     293table tr.debug th {background-color:#FFC2D0 !important;}
     294ul li.debug {background-color:#FFC2D0 !important;}
     295
    291296/* [autodoc] bouton proposer une amélioration */
    292297a.proposer {margin-top:1em; float:right;}
  • _galaxie_/code.spip.net/autodoc/trunk/templates/zora/inclure/liste/spiperies.twig

    r74883 r74891  
    1818                        <tbody>
    1919                        {% for function in elements %}
    20                                 <tr>
     20                                <tr
     21                                        {{- function.tags[type].0.wasMissing ? " class='was_missing' " : '' -}}
     22                                >
    2123                                        <th><a href="{{ path( function ) }}">
    2224                                                {{ before_name }}{{ function.tags[type].0.description }}</a></th>
  • _galaxie_/code.spip.net/autodoc/trunk/templates/zora/js/perso.js

    r74731 r74891  
    1010}
    1111
     12
     13// actions lorsqu'on veut débugguer
     14$.autodoc = {}
     15$.autodoc.debug = function(activer) {
     16        if (typeof activer == 'undefined') {
     17                activer = true;
     18        }
     19
     20        if (activer) {
     21                window.console && console.info("Mode debug activé");
     22
     23                $('body').find('.was_missing')
     24                        .addClass('debug')
     25                        .attr('title', 'Tag absent du phpdoc et ajouté automatiquement');
     26
     27        } else {
     28                window.console && console.info("Mode debug désactivé");
     29
     30                $('body').find('.debug').removeClass('debug').attr('title', null);
     31        }
     32}
     33
     34
    1235$(document).ready(function(){
     36
     37        window.console && console.info(
     38                "[autodoc] Vous pouvez afficher des informations supplémentaires avec :\n" +
     39                "- %c?debug=1%c dans l'URL ou\n" +
     40                "- %c$.autodoc.debug(true)%c dans la console"
     41        , "color:brown", "", "color:brown", "");
     42
     43        // mode de debug dans l'url. ?debug=1
     44        // on fait du coloriage…
     45        modeDebug = (parseInt($.getURLParameter('debug')) == 1);
     46        if (modeDebug) {
     47                $.autodoc.debug();
     48        }
    1349
    1450        // l'ancre a t'elle changé suite à un changement d'url (clic d'un lien interne) ?
Note: See TracChangeset for help on using the changeset viewer.