appledoc
2.2.1 build 1333
AVIS IMPORTANT : collaborateurs recherchés
appledoc est un outil de ligne de commande qui aide les développeurs Objective-C à générer une documentation de code source de type Apple à partir de commentaires de code source spécialement formatés. Il est conçu pour prendre des commentaires de code source aussi lisibles que possible pour la saisie et utiliser les commentaires ainsi que le code source environnant pour générer une documentation visuellement attrayante sous forme de HTML ainsi qu'un ensemble de documentation Xcode entièrement indexé et consultable. Bien qu'il existe plusieurs outils permettant de créer de la documentation HTML pour Objective-C, tous ceux que je connais ne parviennent pas à atteindre les objectifs minimum décrits ci-dessous.
Principaux objectifs d'appledoc :
Pour rendre votre expérience avec appledoc aussi fluide que possible, nous vous suggérons chaleureusement de lire l'intégralité de ce document ainsi que toute la documentation en ligne mentionnée dans la section « Utilisation d'appledoc » ci-dessous !
L'utilisation d'appledoc est autorisée selon les termes répertoriés dans la section LICENCE au bas de ce fichier !
Vous voulez rester informé ? Suivez-nous sur Twitter - @gentlebytes.
La méthode recommandée consiste à cloner le projet GitHub et à compiler l'outil à partir de Xcode. Comme le clonage du projet GitHub créera le lien vers le référentiel principal, cela simplifie également grandement les futures mises à niveau. Pour installer, tapez ce qui suit dans le terminal :
git clone git://github.com/tomaz/appledoc.git
Cela crée le répertoire appledoc. Vous y trouverez l'espace de travail appledoc.xcworkspace Xcode ; ouvrez-le et compilez la cible appledoc - cela devrait fonctionner immédiatement, mais votre système doit répondre à la configuration minimale requise, voir ci-dessous. Je vous recommande de copier l'exécutable appledoc résultant du répertoire de construction vers l'un des répertoires de votre chemin ( echo $PATH ) pour le rendre facilement accessible.
Facultatif : Appledoc est autonome et contient les fichiers modèles nécessaires. SI vous souhaitez modifier ces valeurs par défaut du sous-répertoire Modèles vers l'un des emplacements attendus :
Vous pouvez également utiliser le script install-appledoc.sh pour effectuer une installation rapide. Ouvrez le terminal et passez au répertoire appledoc. Tapez la commande suivante :
sudo sh install-appledoc.sh (if you need templates add '-t default')
Il compile appledoc et installe son binaire dans /usr/local/bin et ses modèles (si vous le souhaitez) dans ~/.appledoc par défaut. Vous pouvez remplacer ces répertoires avec les options -b et -t respectivement. Par exemple:
sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application Support/appledoc
Alternativement avec Homebrew :
brew install appledoc
Homebrew n'installe pas de modèles par défaut.
Utilisez appledoc --help pour voir la liste de tous les commutateurs de ligne de commande. En savoir plus sur appledoc sur le site appledoc. Lisez également les pages wiki pour des articles plus approfondis.
Utilisez le groupe Google appledoc comme forum pour les questions d'utilisation ou d'autres questions générales.
Utilisez la page des problèmes Appledoc pour soumettre des demandes de bogues et de fonctionnalités. Avant de soumettre de nouveaux problèmes, consultez les forums pour voir si votre question y trouve une réponse. À moins que vous ne puissiez confirmer votre problème en tant que demande de nouvelle fonctionnalité ou bug, vous devez commencer par le forum pour garder les problèmes GitHub propres. Lisez également les problèmes pour voir si le problème est déjà là et votez dessus ou ajoutez un commentaire (n'oubliez pas les problèmes fermés).
Pour rester à jour, allez simplement dans Terminal et cd dans le répertoire appledoc, lancez git pull et recompilez appledoc.xcodeproj. N'oubliez pas d'écraser l'exécutable appledoc que vous avez copié dans $PATH :)
Si vous souhaitez également compiler et exécuter la cible AppledocTests (tests unitaires), vous devez copier tous les frameworks indiqués dans le groupe Libraries & Frameworks dans le répertoire des frameworks partagés avant de créer la cible des tests unitaires ! Ceci n'est pas requis pour créer l'outil appledoc lui-même.
Vous pouvez configurer Xcode pour automatiser la création de documents appledoc. Découvrez comment utiliser un script d'exécution et les phases de construction de votre projet.
La documentation et les ensembles de documents pré-générés pour la plupart des frameworks Cocoa sont disponibles sur :
Une fois que vous disposez d'un ensemble de documents, vous souhaiterez peut-être l'utiliser avec un navigateur de documentation :
Vous avez des problèmes ? Voici ce que vous pouvez faire pour dépanner :
git pull et exécutez à nouveau avec la dernière version.--verbose . Le niveau par défaut est 2, mais vous pouvez progressivement augmenter la verbosité jusqu'à 6, chaque niveau vous donnant des informations plus détaillées. Comme cela vous donnera beaucoup plus d'informations, vous souhaiterez peut-être vous concentrer uniquement sur un ensemble spécifique de fichiers sources avec lesquels vous rencontrez des problèmes. Notez que l'augmentation de la verbosité entraînera un ralentissement des performances. Il n'est donc pas recommandé d'utiliser des niveaux supérieurs à 4 pour une utilisation quotidienne.Si vous souhaitez contribuer, consultez le fichier Developer Notes pour un bref aperçu du fonctionnement interne d'appledoc.
appledoc est sous licence BSD modifiée. En langage clair : vous êtes autorisé à faire ce que vous voulez avec le code, modifier, redistribuer, intégrer dans vos produits (gratuits ou commerciaux), mais vous devez inclure les droits d'auteur, les conditions d'utilisation et la clause de non-responsabilité comme indiqué dans la licence, les mêmes comme n’importe quel autre code sous licence BSD. Vous pouvez bien sûr utiliser la documentation générée par appledoc pour vos produits (gratuite ou commerciale), mais vous devez attribuer appledoc soit dans la documentation elle-même, soit à un autre endroit approprié tel que votre site web.
Si, pour une raison quelconque, vous ne pouvez pas accepter ces conditions, contactez-nous via le formulaire de contact sur notre page À propos, nous ferons de notre mieux pour vous aider et trouver une solution viable !
Copyright (c) 2009-2011, Gentle Bytes Tous droits réservés.
La redistribution et l'utilisation dans les formulaires sources, binaires et la documentation générée, avec ou sans modification, sont autorisées à condition que les conditions suivantes soient remplies :
Les redistributions du code source doivent conserver l'avis de droit d'auteur ci-dessus, cette liste de conditions et la clause de non-responsabilité suivante.
Les redistributions sous forme binaire doivent reproduire l'avis de droit d'auteur ci-dessus, cette liste de conditions et la clause de non-responsabilité suivante dans la documentation et/ou tout autre matériel fourni avec la distribution.
Les redistributions de la documentation générée par appledoc doivent inclure l'attribution à appledoc, soit dans la documentation elle-même, soit dans d'autres supports appropriés.
Ni le nom d'appledoc, Gentle Bytes, ni les noms de ses contributeurs ne peuvent être utilisés pour approuver ou promouvoir des produits dérivés de ce logiciel sans autorisation écrite préalable spécifique.
CE LOGICIEL EST FOURNI PAR LES TITULAIRES DES DROITS D'AUTEUR ET LES CONTRIBUTEURS « EN L'ÉTAT » ET TOUTE GARANTIE EXPRESSE OU IMPLICITE, Y COMPRIS, MAIS SANS LIMITATION, LES GARANTIES IMPLICITES DE QUALITÉ MARCHANDE ET D'ADAPTATION À UN USAGE PARTICULIER EST DÉCLINÉE. EN AUCUN CAS LE TITULAIRE DES DROITS D'AUTEUR OU LES CONTRIBUTEURS NE SERONT RESPONSABLES DE TOUT DOMMAGE DIRECT, INDIRECT, ACCESSOIRE, SPÉCIAL, EXEMPLAIRE OU CONSÉCUTIF (Y COMPRIS, MAIS SANS LIMITATION, L'ACHAT DE BIENS OU DE SERVICES DE SUBSTITUTION ; LA PERTE D'UTILISATION, DE DONNÉES OU DE PROFITS ; OU INTERRUPTION DES ACTIVITÉS) QUELLE QUE CE SOIT LA CAUSE ET SUR TOUTE THÉORIE DE RESPONSABILITÉ, QU'ELLE SOIT CONTRACTUELLE, STRICTE OU DÉLIT (Y COMPRIS LA NÉGLIGENCE OU AUTRE) DÉCOULANT DE QUELQUE MANIÈRE QUE CE SOIT DE L'UTILISATION DE CE LOGICIEL, MÊME SI INFORMÉ DE LA POSSIBILITÉ DE TELS DOMMAGES.
Gentle Bytes [email protected]
