Bienvenue sur le projet PasDoc
PasDoc est un outil de documentation pour les codes source en ObjectPascal.
Il vise à être très flexible, rapide et avoir un résultat facilement utilisable.
La documentation est générée à partir des commentaires du code source Pascal. Les documents générés peuvent être au format HTML, HtmlHelp et LaTeX. D'autre formats pourront être ajouté dans le futur.
PasDoc a quelques fonctionnalités unique:
systeme de cache pour une génération plus rapide de la documentation (cf CacheOption )
possibilité de choisir arbitrairement les marqueurs de commentaire.
génération des fichiers supplémentaires pour créer un fichier HtmlHelp.
le format de sortie latex2rtf permet de produire des fichiers LaTeX pouvant être mieux interprétés par latex2rtf.
Voir SupportedTags and WritingDocumentation pour plus d'information sur comment documenter votre code source.
Voir CommandLine pour avoir une idée de comment fonction PasDoc.
Téléchargement de PasDoc à Sourceforge download page
Allez voir ProjectsUsingPasDoc pour avoir des exemples réels de documentions réalisées avec PasDoc et pour voir des programmes qui utilisent PasDoc.
Si il vous manque quelque chose, ajoutez le à la liste WantedFeatures ou voyez la liste ToDo pour ce qui devrait être dans le code actuel. Enfin, PasDoc2 présente les évolutions envisagées.
PasDoc est distribué sous licence GNU General Public License.
Nous utilisons le wiki MoinMoin pour que ces pages soient facile à mettre à jour. Vous êtes invitez à contribuer à enrichir la documentation. cf WikiIntroduction.
Voir ChangeLog pour les changement récents de PasDoc et un court historique.
Envoyez vos impressions à la MailingList.
Vous pourvez avoir la dernière version sur CVS version
Voir CompilingPasDoc pour apprendre comment compiler vous même pasdoc.
Tous les services associés à ce projet sont fournis par SourceForge http://sourceforge.net/sflogo.php?group_id=4213&type=1&d.gif
Wiki MoinMoin
Points de départ intéressants :
ModificationsRécentes : voyez sur quoi les utilisateurs sont en train de travailler
BacÀSable : n'hésitez pas à modifier cette page et à vous entraîner à l'édition de page
RechercherUnePage : recherchez dans la base de données ou parcourez-la de diverses manières
RésuméDeLaSyntaxe : accès rapide à la syntaxe du wiki
ExplorerCeWiki : divers moyens d'explorer ce site
Comment utiliser ce site
Un Wiki est un site collaboratif, n'importe qui peut contribuer et partager ses connaissances :
Éditez n'importe quelle page en cliquant sur Edit en haut ou en bas de la page
Créez un lien vers une autre page en accolant des mots qui commencent par une majuscule (comme par exemple ModificationsRécentes), ou avec ["des mots entre crochets et guillemets"]
- Rechercher des titres de page ou du texte dans les pages en utilisant le formulaire de recherche en haut de chaque page
Consultez l'AideAuxDébutants dans un premier temps ; le SommaireDeL'Aide liste toutes les pages d'aide.
Pour en savoir plus sur ce qu'est un WikiWikiWeb, lisez WhyWikiWorks et WikiNature. Vous pouvez également consulter la WikiWikiWebFaq.
Ce site fonctionne grâce à MoinMoin.