Discussion :

[askarims]

Bonjour,

J'aimerais savoir si quelqu'un a déjà utiliser les fonctionnalités de Matlab permettant la génération de doc (info.xml, helptoc.xml, help.jar, etc...) ?

Je n'ai pas bien compris l'aide de Matlab, car la solution semble être la production manuelle de fichiers html ?

Merci d'avance.

[Invité]

Bonjour,

Que souhaites-tu faire exactement ? À partir de quel support ?

[askarims]

Actuellement j'ai bien commenté mon code et en utilisant les fonctions helpwin ou doc, je peux naviguer sur différentes pages dans l'aide de Matlab correspondant aux différentes classes et fonctions de mon code.
Matlab génère des liens automatiques avec les classes parentes et j'ai pris soin d'ajouter un commentaire sur chaque membre de classe et méthode ainsi qu'un "See also" et des exemples dans le commentaire de tête.

Ce que j'aimerais ajouter, c'est une description plus fonctionnelle du code, par exemple des démos, ajouter des illustrations, utiliser les possibilités de création d'un getting started et d'user's guide sur mes propres packages afin de décrire de manière plus globale un projet et non pas simplement une description d'une classe en particulier.

Ce que je n'ai pas bien compris c'est dans quelle mesure je dois rédiger mes pages html, le css de mes pages est-il automatique, etc...
Le fichier info.xml me permet d'ajouter une entrée dans le menu start de Matlab, mais comment l'alimenter simplement ensuite ?

Je trouve les explications de l'aide un peu juste à ce sujet.

Mon but est d'utiliser ces fonctionnalités de Matlab pour permettre à une équipe de développement d'accéder dans le même espace à une description des classes/méthodes (style javadoc) et à une description fonctionnelle décrivant ce que fait le programme avec des exemples de résultats de traitement, le détail des choix effectués dans les algorithmes.

Concernant le support j'ai cru comprendre qu'il s'agissait de pages html ou xml liés à un .jar, cela me convient, un export vers des formats type pdf est aussi intéressant.

Merci d'avance pour votre aide.