marcimat@rezo.net
47a1ca8743
Pour générer la page d'accueil avec toutes les descriptions des plugins documentés,
...
il faut récupérer leurs infos (titre, descriptif, etc), même si leur documentation n'a pas
besoin d'être régénérée.
7 years ago
marcimat@rezo.net
50edb6be80
Pas besoin de préparer un fichier phpdoc.xml si la documentation n'a pas besoin d'être actualisée.
...
(une ligne de log en moins).
7 years ago
marcimat@rezo.net
4ac7b2fa49
Permettre de générer uniquement un certain prefixe lorsqu'on demande à générer tout un fichier qui liste de documentations (autodoc.txt).
7 years ago
marcimat@rezo.net
bfc6e66177
Éviter que la description d'une fonction touche l'icone d'api.
7 years ago
marcimat@rezo.net
93428f3c1d
Logs moins loquaces
7 years ago
marcimat@rezo.net
8829af6be0
Optimiser la création de la documentation phpdoc des plugins en ne régénérant pas la doc si un plugin n'a pas eu de mise à jour depuis la précédente génération.
7 years ago
marcimat@rezo.net
f812af9d16
Basculer sur la norme P30-c pour l'intégration de la boussole (_eric_)
7 years ago
marcimat@rezo.net
51545d0e7d
Pour Éric : gérer un paramètre d'appel supplémentaire sur le helper nommé --avec_boussole_spip qui ajuotera la boussole SPIP sur la documentation générée.
...
De même, alternativement, --topnav=URL ajoutera le js contenu dans l'url indiquée dans le header.
Exemple : `autodoc/bin/autodoc_helper from:file --avec_boussole_spip`
Génère la documentation des plugins de la zone, avec la boussole intégrée.
7 years ago
marcimat@rezo.net
859f139812
Forcer un test sur le contenu textuel (ce sont des objets ici)
7 years ago
marcimat@rezo.net
120d876b23
Le fond jaunatre, c'est sympa, mais pas très lisible. Donc, quelques corrections de CSS.
...
Et on évite les shadow, c'est pas très joli.
7 years ago
marcimat@rezo.net
ccd1b196f0
Réparer enfin les cas des exemples dont il manquait parfois le premier mot.
...
En fait, phpdocumentor attend : @example url [start?] [stop?] [description?]
mais nous on écrit simplement : @example texte d'exemple
qui ne correspond pas à une url. Le premier mot ou suite de caractères avant un espace
est considéré comme l'url (inexistante), et ne fait pas partie de la description.
Donc, on remet l'url fausse, dans la description, avec start et stop (numéro de première ligne et nombre de ligne)
s'ils avaient aussi été capturés par hasard des textes.
7 years ago
marcimat@rezo.net
a69b8c4c3c
Le tri des filtres est particulier car certains sont nommés 'nn', et d'autres 'filtres_nn'. On trie effectivement sur 'nn'
7 years ago
marcimat@rezo.net
bd37a3718e
L'identifiant de div ne doit pas être le même pour les erreurs et notices.
7 years ago
marcimat@rezo.net
b30f41e568
Séparer les graphs d'erreurs des notices. colorier un peu.
7 years ago
marcimat@rezo.net
23158b7bd6
Ne pas oublier la div qui reçoit le graphique !
7 years ago
marcimat@rezo.net
525ec6b0d2
Faire un premier graphique de statistiques sur uniquement 30 jours.
...
Quelle ennui en JS pour simplement surcharger une fonction dans une nouvelle classe sans impacter la fonction d'origine de la classe étendue…
7 years ago
marcimat@rezo.net
2fae088e35
La topnav doit revenir sur l'autodoc si on la demande !
8 years ago
marcimat@rezo.net
305e103c30
Les options de configuration ajoutées au fichier phpdoc.xml n'étaient plus prises en compte dans les templates twig (en utilisant : configuration.options.titre.value par exemple). On corrige ce détail.
8 years ago
marcimat@rezo.net
6815b392a5
Ne pas faire de var_dump complet, cela peut faire planter php à cause des liens croisés. On commente ce code, et on évite de génerer le fichier debug.html au passage.
8 years ago
marcimat@rezo.net
441c34c710
Ces 2 fichiers sont exécutables
8 years ago
marcimat@rezo.net
d254b9da81
Mise à jour de l'installation.
8 years ago
marcimat@rezo.net
9c9c14dce4
Oubli dans le report de r87563
8 years ago
marcimat@rezo.net
81c94f55d7
Lorsqu'aucun @package n'est déclaré sur le fichier, les fonctions ayant une @api généraient une erreur. On évite cela en mettant par défaut ces fonctions dans un groupe d'API : 'Orphelins (sans @package )'.
8 years ago
marcimat@rezo.net
b5faaa5459
Report de r87564 : Ne plus supprimer les vieux fichiers ou dossiers ; un changement de comportement de phpdocumentor fait qu'ils ne sont pas forcément recréés lors d'une génération de la documentation et que du coup, notre tentative d'enlever les fichiers et dossiers périmés en fonction du timestamp ne fonctionne plus.
8 years ago
marcimat@rezo.net
014fc46a51
Report de r87563 : Il faut rééchapper les texte pour XML pour construire notre XML pour phpdocumentor, sinon les documentations ayant des urls avec des & ne passaient pas.
8 years ago
marcimat@rezo.net
a7d66f3218
Code devenu inutile
9 years ago
marcimat@rezo.net
05ad9a1a02
Migration vers phpDocumentor 2.6.1
...
Nombreuses adaptations :
1) les binaires sont maintenant sans extension .php
2) Pour tenir compte des <options> que l'ont passait dans phpdoc.xml, spécifique à l'autodoc,
il faut grandement ruser maintenant car le sérialiseur / désérialiseur utilisé maintenant par phpdocumentor
ne conserve que les éléments qui lui sont déclarés. Pour cela, on surcharge donc la classe Configuration
de phpdocumentor pour ajouter notre tableau d'options.
À noter que la syntaxe est légèrement différente (voir Helpers/phpdoc_helper.xml)
3) Pour faire parvenir les données de configuration au template Twig, et suite toujours au
changement dans la gestion de la configuration de phpdocumentor, on transmet directement
aux template la configuration connue (sans la recalculer). Mais pour cela, on doit
surcharger le Writer/Twig pour ajouter notre élément. La surcharge est minime heureusement.
4) L'autoloader est déclaré différemment également. Il est appelé avant le chargement de phpDocumentor
et lui est transmis lors de la création (new Application(...)). On s'adapte (dans bin/autodoc) et on
adapte toutes les commandes Helpers pour transmettre cet autoloader… Pfiou.
Du coup, pour simplifier un peu, on crée une Application pour le Helpers, et on déporte
de bin/autodoc_helper vers l'application la déclaration des commandes utilisables.
9 years ago
marcimat@rezo.net
3b0d2708aa
le numéro de ligne à droite, ça fera plus propre.
9 years ago
marcimat@rezo.net
c0d6a24fd8
Pour élargir la colonne décrivant les erreurs, on met sur la même colonne le fichier et la description de l'erreur.
9 years ago
marcimat@rezo.net
814ce60cb8
Allègement graphique des erreurs…
9 years ago
marcimat@rezo.net
1155846283
Essayons d'alléger un peu la liste complète des erreurs en n'affichant qu'une fois chaque fichier.
9 years ago
marcimat@rezo.net
d31d39c757
2 fichiers oubliés !
9 years ago
marcimat@rezo.net
5c2cd36e80
Ranger les erreurs par ligne aussi sur la liste complète des erreurs. Et mettre un lien vers la source du fichier également.
9 years ago
marcimat@rezo.net
85d7f930b9
Liens vers les package respectifs sur les fonctions et constantes
9 years ago
marcimat@rezo.net
8272334475
Ne pas créer une liste vide sur des @tag non spécifiques qui n'ont pas de description (tel que @internal ).
9 years ago
marcimat@rezo.net
701a585d5f
Trier aussi par sévérité pour faire 1 ligne de tableau par ligne d'erreur et sévérité d'erreur
9 years ago
marcimat@rezo.net
7dc1b6e7d3
Lister les erreurs par ligne pour plus de clarté (Teddy) (1/2)
9 years ago
marcimat@rezo.net
4cb4f3dd2f
- Le cache de Twig se met à jour si le code source du template change (na !)
...
- Commentaire inutile.
9 years ago
marcimat@rezo.net
57c69e4414
Les package affichent la liste des fichiers
9 years ago
marcimat@rezo.net
d67f99c3cb
Préfixer la description des passes de compilateur pour plus de distinction
9 years ago
marcimat@rezo.net
92c0eb8322
Quelques corrections :
...
- prises en compte des constantes dans les @uses et de leurs affichages
- pas d'affichage intempestif du tag @todo sur les classes
9 years ago
marcimat@rezo.net
e1ab59d371
Oubli de commit ! On réexécute le plugin pour twig pour notre template !
9 years ago
marcimat@rezo.net
6bd9f4fccb
Adaptation à phpDocumentor 2.4
9 years ago
marcimat@rezo.net
a629f46f24
1è adaptations du code pour phpDocumentor 2.3.2
9 years ago
marcimat@rezo.net
484e2ffa6a
Mettre la boussole JS (suite)
9 years ago
marcimat@rezo.net
e03ac1bb98
Mettre code.spip.net sur la boussole JS, ainsi que l'autodoc généré.
9 years ago
marcimat@rezo.net
f5fd018bea
adapter à la nouvelle hauteur de la topnav
10 years ago
marcimat@rezo.net
93f70b672f
On prend en compte une nouvelle option dans la génération des phpdoc : 'topnav'. Mis à oui, et en présence de l'option site renseignée, cela demande à intégrer une topnav comme sur le site défini. De la même manière que r75786, on ajoute au HTML le cas échéant la classe avec_boussole_topnav qui décalera l'entête. On télécharge alors `$site/?page=boussole_topnav` pour le code HTML à insérer et `$site/?page=boussole_topnav_css` pour le code CSS.
...
De la sorte, si le plugin boussole est mis à jour sur le site principal, ça sera répercuté peu après sur l'autodoc.
10 years ago
marcimat@rezo.net
e856daacd1
Coquille
10 years ago
marcimat@rezo.net
a7b508c794
pas de dump !
10 years ago