Méthode Générer la documentation

Aide LabVIEW 2014

Date d'édition : June 2014

Numéro de référence : 371361L-0114

»Afficher les infos sur le produit
Télécharger l'aide (Windows uniquement)

Nom court : Générer documentation

Requiert : Système de développement de base

Classe : Méthodes de BibliothèqueDiagrammeÉtatsTransitions

Conseils d'utilisation : Création de propriétés et de méthodes.

Génère un fichier XML qui contient des informations sur tous les composants, notamment les états, les pseudo-états, les connecteurs, les régions et les transitions d'un diagramme d'états-transitions. Vous pouvez afficher le fichier XML dans un navigateur Web.

Cette méthode génère aussi un dossier de fichiers de support au même endroit que le fichier XML que vous générez. Ce dossier de support contient des fichiers auxquels le fichier XML fait référence, notamment des images des composants du diagramme d'états-transitions, un fichier XSLT (EXtensible Stylesheet Language Transformations) et un fichier XSD (XML Schema Definition).

Remarque  Vous pouvez distribuer votre fichier XML généré et le dossier de support qui contient les fichiers XSLT et XSD librement. Toutefois, National Instruments possède tous les droits d'auteur sur NI_Statechart_Documentation_Tool.xslt et NI_Statechart_Documentation_Tool.xsd. N'utilisez pas ni ne distribuez pas ces fichiers sans le fichier XML associé et le dossier de support généré par la fonctionnalité Generate Documentation du module LabVIEW Statechart. Vous pouvez modifier le fichier NI_Statechart_Documentation_Tool.xslt, mais il doit conserver la notice relative aux droits d'auteur de National Instruments qu'il contient et qui ne doit être ni modifiée ni cachée. Vous devez en outre ajouter une mention bien en évidence au début du fichier déclarant que vous avez modifié le fichier. Vous ne devez pas modifier le fichier NI_Statechart_Documentation_Tool.xsd.

Cette méthode est semblable à l'élément Generate Documentation dans le menu déroulant d'un élément .lvsc, ou bibliothèque de diagramme d'états-transitions, dans un projet de diagramme d'états-transitions. Cette méthode est également similaire à l'élément de menu File»Generate Documentation dans la fenêtre d'édition d'un diagramme d'états-transitions.

Paramètres

Type de donnéesNomNécessaireDescription
CheminOuiSpécifie l'emplacement dans lequel LabVIEW enregistre le fichier XML et le dossier des fichiers de support. Le chemin que vous spécifiez doit se terminer par l'extension de fichier .xml. La valeur par défaut est le même emplacement que celui du diagramme d'états-transitions que vous documentez.

Remarques

Le tableau suivant liste les caractéristiques de cette méthode.

Type de donnéesAucune valeur renvoyée
Disponible dans le moteur d'exécutionNon
Disponible dans le système d'exploitation temps réelNon
Modifiable en cours d'exécutionNon
Charge la face-avant en mémoireNon
Authentification nécessaire avant utilisationNon
Charge le diagramme en mémoireNon
Accès à distance autoriséOui

CET ARTICLE VOUS A-T-IL ÉTÉ UTILE ?

Pas utile