comment utiliser appledoc pour générer une Pomme-comme documentations

Je lis sur l'article comment générer une Pomme-comme le HTML de la documentation à ici. Mes questions sont ce que les lignes de commande sont utilisés pour. Comment pouvons-nous combiner les lignes de commande et appledoc xcode projet pour générer un HTML.

Je doute que la plupart des gens sont familiers avec le "appledoc" du projet, de sorte que vous pouvez expliquer à votre question un peu plus.

OriginalL'auteur tranvutuan | 2012-03-21

  1. 13

    Je n'ai pas utilisé "appledoc", mais à partir d'un rapide coup d'œil à la page liée, il apparaît que c'est un open-source de l'utilitaire de ligne de commande. Donc, la première étape sera de compiler les " appledoc programme lui-même, et ensuite le coller dans un répertoire qui est dans votre chemin, comme /usr/local/bin ou ~/bin/.

    La prochaine étape est d'essayer de l'utiliser pour générer de la documentation (en supposant que vous avez déjà créé la démarque des fichiers qu'il consomme). Ouvrez une fenêtre de terminal, allez dans le répertoire contenant vos fichiers, puis utiliser la commande donnée en haut de la page que vous avez lié:

    appledoc --project-name appledoc --project-company "Gentle Bytes" --company-id com.gentlebytes --output ~/help .

    Si vous souhaitez utiliser 'appledoc" pour régénérer votre documentation chaque fois que vous créez un projet, vous pouvez ajouter un "Run Script" phase de construction à une cible dans votre projet, ou de créer une nouvelle cible pour la documentation qui n'a rien, mais un "Run Script" phase de construction. De toute façon, le script dans cette phase doit être d'un script shell contenant une commande semblable à celui ci-dessus (bien que vous aurez probablement besoin de spécifier le répertoire source explicitement plutôt que de simplement en utilisant le répertoire "current", c'est à dire .).

    OriginalL'auteur Caleb

  2. 19

    Je suis l'auteur de appledoc outil. L'outil est destiné à être utilisé comme répondu par Caleb ci-dessus. Recommandé méthode d'installation est de dupliquer le référentiel à partir de GitHub, ouvrir un projet dans Xcode, construire et éventuellement copie binaire de votre chemin, comme suggéré ci-dessus. En outre, vous devez également copier les fichiers de modèle requis pour l'exécution de l'outil à l'un des chemins prédéfinis. Toutes les étapes nécessaires sont décrits dans le fichier lisezmoi sur appledoc page sur GitHub, voir l'Installation Rapide de l'article.

    Il ya aussi d'autres méthodes pour l'installation - contribution de tous les utilisateurs:

    • Vous pouvez utiliser install-appledoc.sh script inclus dans le dépôt git.
    • Il y a aussi homebrew recette disponible, même s'il ne veut pas installer les fichiers de modèle à ma connaissance (voir ce lien).

    Pour toute question supplémentaire aller à appledoc groupe Google. Je viens de créé il ya quelques jours, donc il n'y a pas de contenu à la rédaction de cet article, mais n'hésitez pas à poser des questions.

    OriginalL'auteur Tom

  3. 4

    Que j'ai trouvé sur ce post, vous pouvez générer un HTML complète la documentation de votre code avec cette ligne de commande:

    appledoc --projet de nom de BabelCPP --le projet de l'entreprise de "Mon Nom"
    --la société id-com.mycompany --no-create-docset --sortie ./doc/.

    Le dernier "." est le chemin d'accès à votre code.

    OriginalL'auteur Kevin Delord