2009-07-30 4 views
10

Je souhaite créer un jeu de documents pour mon API qui ressemble et fonctionne comme le jeu de documentation Apple Core Library. Par exemple, regardez la page pour NSString.Comment créer des jeux de documents Xcode qui ressemblent et fonctionnent comme ceux de la bibliothèque Apple Core

J'ai essayé Doxygen et j'ai essayé headerdoc2html. Ni très proche de ce que je veux.

Les fichiers générés par headerdoc ne possèdent pas la plupart de la structure de niveau supérieur que les fichiers Apple font, et la conception graphique est différente. Vers le bas au niveau plus détaillé, comme lorsque vous regardez une méthode spécifique, les choses sont plus proches, mais n'ont pas toute 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'une conception graphique très différente.

Que dois-je essayer d'autre? Ou y a-t-il des paramètres à l'un ou l'autre de ces outils qui me donneraient quelque chose de plus proche?

Merci, Pat

Répondre

1

Vous pouvez utiliser Doxygen to generate Xcode docsets.

+0

La question était de savoir comment générer des jeux de documents Xcode qui ressemblent à ceux qu'Apple livre pour ses API. Si Doxygen peut le faire, je n'ai pas encore compris comment. –

+0

oh, bien dans ce cas ne pouvez-vous pas simplement utiliser un CSS personnalisé qui ressemble à celui d'Apple? –

+0

Soit je ne comprends pas toutes les capacités des CSS, soit les différences sont beaucoup plus importantes qu'un CSS peut gérer. Par exemple, tout ce qui se trouve dans la colonne de gauche a une structure complètement différente, et pas seulement un aspect différent. J'ai regardé plusieurs exemples d'utilisation de doxygen en plus de mes propres expériences. Tout ce que j'ai vu montre que la sortie de doxygen a une structure, un format et un look très différents, ce qui est très différent de celui fourni par Apple. –

0

Unfortunatelly, la sortie Doxygen recherche et de se comporter comme un développeur d'Apple bibliothèque de documents est encore à découvrir ...

0

Je suis aussi très intéressé par cet :(Ive été en mesure de générer docsets et doxygen docs, mais si je pouvais les faire ressembler (ou s'approchant) aux docs "normaux" (comme ceux du SDK), ce serait mieux:/

10

Le meilleur que j'ai trouvé jusqu'ici est Tomaz's appledoc. créer une documentation api de style pomme et installez-la directement dans les DocSets que Xcode utilise.Très bien et est basé sur doxygen

+0

Salut Derek, J'aurais dû répondre plus tôt. J'ai fait ce projet en modifiant manuellement le HTML en août. (Ugh! Massive Ugh! Mais ça a marché.) Quand j'ai besoin de le mettre à jour, je vais regarder les affaires de Tomaz. Je ne veux pas accepter une réponse jusqu'à ce que je l'ai essayé, mais je vais revenir sur ce point quand je l'ai fait. Merci, Pat –

+0

Il ya un bon exemple de rendu (avec appledoc) ici: http://www.gentlebytes.com/content/appledoc/exampledoc/ (gentil, au moins plus agréable que le rendu doxygen de base;) – yonel

+0

Oui, appleDoc ne cesse de s'améliorer. Non, je ne l'ai pas écrit :-) – drekka

Questions connexes