Apr 24, 2017 2:04:36 PM Pauline Rouvel avatar   130    

Générer la documentation des macros Freemarker

Introduction

Le plugin docgenerator permet de générer la documentation technique du fichier commons.html, afin de détailler le fonctionnement des macros Freemarker. Le texte généré se base sur la lecture des lignes de codes et des commentaires pour les analyser et les intégrer à la documentation.

Page d'accueil du plugin :

Image Accueil

Prérequis

Pour permettre au plugin de fonctionner, la rédaction du fichier commons.html doit respecter certaines normes d'écriture.

<#-- _doc : BackGround -->
<#-- _title : pBackGround-->
<#-- _param : Bootstrap colors: primary/success/info/warning/danger -->
<#-- _param : AdminTLE colors: gray/gray-light/black/red/yellow/aqua/blue/light-blue/green/navy/teal/olive/lime/orange/fuchsia/purple/maroon -->
<#-- _html : <input type="text" value="submit"> -->
<#-- _call :<@td></@td>-->
<#-- _description : Description de la première macro  -->
<#-- autres informations supplémentaires  -->

<#macro pBackground color=''>
	<p class="bg-${color}"><#nested></p>
</#macro>

A chaque nouvelle macro du fichier, un bloc de commentaires descriptifs est placé au dessus de celle-ci. Chaque indication sur la macro doit être contenu dans un seul commentaire.

  • _doc : groupe de macros
  • _title : titre de la macro
  • _param : paramètres (à chaque nouveau paramètres, faire une nouvelle ligne)
  • _html : code html représenté par la macro (il sera écrit en dur dans la doc et interprété à coté)
  • _call : appel de la macro
  • _description : description
  • Aucun titre : informations supplémentaires

Les champs _doc, _description et "Aucun titre" sont facultatifs.

Utilisation

Afin de lancer la génération de la documentation technique, il suffit de cliquer sur le bouton "Lancer la génération".

Rendu de la documentation générée :

Rendu de la doc