Je veux créer un doct pour mon API qui a l'air et fonctionne comme la bibliothèque Apple Core Docset. Par exemple, consultez la page pour Nstring.
J'ai essayé Doxygen et j'ai essayé HeaderDoc2HTML. Ni très près de ce que je veux.
Les fichiers générés par Headerdoc n'ont pas la plus grande partie de la structure de niveau supérieur que les fichiers Apple le font et que la conception graphique est différente. Au niveau plus détaillé, comme lorsque vous regardez une méthode spécifique, les choses sont plus proches, mais n'ont pas toutes la structure détaillée.
Les fichiers générés par Doxygen ont une structure de haut niveau très différente, sans parler d'avoir une conception graphique très différente.
Que devrais-je essayer d'autre? Ou y a-t-il des paramètres à l'un ou l'autre de ces outils qui me donnerait quelque chose de plus proche?
merci, pat
4 Réponses :
Vous pouvez utiliser DOXYGEN pour générer Xcode Docsets .
La question était de générer des documentsts Xcode qui ressemblent à ceux que Apple fournit pour leurs API. Si Doxygen peut faire cela, je n'ai pas encore compris comment.
Oh, bien dans ce cas, vous ne pouvez pas simplement utiliser un CSS personnalisé qui ressemble à Apple?
Soit je ne comprends pas toutes les capacités de CSSS ou que les différences sont beaucoup plus qu'un CSS peut gérer. Par exemple, toutes les choses de la colonne de gauche ont une structure complètement différente, pas seulement un aspect différent. J'ai examiné plusieurs exemples d'utilisation de Doxygen en plus de mes propres expériences. Tout ce que j'ai vu montre une sortie Doxygen comme ayant une structure, un format et un look très distinctif, ce qui est très différent de celui livré par Apple.
Malheureusement, la sortie Doxygen à la recherche et se comporter comme un document de bibliothèque de développeur Apple doit encore être découverte ...
Je suis aussi vraiment intéressé par cela :( Ive a été capable de générer des docsets et Doxygen Docs, mais si je pouvais les faire ressembler à la même chose (ou à approcher) en tant que documents «normaux» de Apple (comme des SDK), cela serait être mieux.: /
Le meilleur que j'ai trouvé jusqu'à présent est Appledoc de Tomaz. Avec cela, je peux créer une documentation de l'API de style Apple et l'installer directement dans les docstsets que Xcode est UISNG. Fonctionne très bien et est basé sur Doxygen.
Bonjour Derek, j'aurais dû répondre plus tôt. J'ai fait ce projet en édité à la main le HTML de retour en août. (Ugh! Ugh massive! Mais cela a fonctionné.) Quand j'ai besoin de le mettre à jour, je vais regarder les choses de Tomaz. Je ne veux pas accepter une réponse avant d'avoir essayé, mais je reviendrai ceci quand j'ai. Merci, tape
Il y a un bon exemple de rendement (avec AppleDoc) ici: GentleBytes.com/content/AppleDoc/exampleoc < / a> (Nice! Au moins plus agréable que la rendu de base Doxygene;)
Oui, AppleDoc continue d'aller de mieux en mieux. Non je n'ai pas écrit :-)