2009-07-30 7 views
10

Chcę utworzyć dokumentację dla mojego interfejsu API, która wygląda i działa tak, jak zestaw dokumentów Apple Core Library. Na przykład spójrz na stronę NSString.Jak utworzyć zestawy dokumentacji Xcode, które wyglądają i działają tak, jak te w Bibliotece głównej Apple

Próbowałem Doxygen i próbowałem headerdoc2html. Ani bardzo blisko tego, co chcę.

Pliki generowane przez headerdoc nie mają większości struktury wyższego poziomu, jaką robią pliki Apple, a projekt graficzny jest inny. W dół na bardziej szczegółowym poziomie, np. Patrząc na określoną metodę, rzeczy są bliższe, ale nie mają całej szczegółowej struktury.

Pliki generowane przez Doxygen mają zupełnie inną strukturę wysokiego poziomu, nie wspominając już o zupełnie innym projekcie graficznym.

Co jeszcze powinienem wypróbować? Czy są jakieś parametry któregoś z tych narzędzi, które dadzą mi coś bliżej?

Dzięki, Pat

Odpowiedz

1
+0

Pytanie brzmiało, jak tworzyć zestawienia Xcode, które wyglądają jak te, które Apple dostarcza dla swoich interfejsów API. Jeśli Doxygen może to zrobić, nie mam pojęcia, jak jeszcze. –

+0

oh, cóż w takim razie nie możesz po prostu użyć niestandardowego CSS, który wygląda jak Apple? –

+0

Albo nie rozumiem wszystkich możliwości CSS, albo różnice są znacznie większe niż obsługa CSS. Na przykład wszystkie rzeczy w kolumnie po lewej stronie mają zupełnie inną strukturę, a nie tylko inny wygląd. Do moich własnych eksperymentów przyjrzałem się kilku przykładom użycia doxygen. Wszystko, co widziałem, pokazuje, że doxygen output ma bardzo charakterystyczną strukturę, format i wygląd, który bardzo różni się od dostarczanego przez Apple. –

0

Niestety, wyjście Doxygen szuka i zachowuje się jak Apple Developer Biblioteka dokumentów jest jeszcze do odkrycia ...

0

Jestem również bardzo zainteresowany tym :(Ive stanie wygenerować docsets doxygen ale i Dokumenty gdybym mógł sprawić, by wyglądały tak samo (lub zbliżały się) jak "normalne" dokumenty Apple (takie jak SDK), byłoby lepiej./

10

Najlepsze, co do tej pory znalazłem to Tomaz's appledoc. utwórz dokumentację api w stylu Apple i zainstaluj ją bezpośrednio w DocSets, z której korzysta Xcode. Działa bardzo dobrze i jest oparta na doxygen

+0

Cześć Derek, Powinienem odpowiedzieć wcześniej. Zrobiłem ten projekt ręcznie edytując kod HTML w sierpniu. (Ugh! Massive Ugh! Ale zadziałało.) Kiedy będę musiał to zaktualizować, popatrzę na rzeczy Tomaza. Nie chcę zaakceptować odpowiedzi, dopóki jej nie spróbuję, ale powrócę do niej, kiedy już to zrobię. Dzięki, Pat –

+0

Istnieje dobry przykład wykonania (z appledoc) tutaj: http://www.gentlebytes.com/content/appledoc/exampledoc/ (ładnie! Co najmniej ładniej niż podstawowa wersja doxygen;) – yonel

+0

Tak, AppleDoc ciągle się poprawia. Nie, nie napisałem tego :-) – drekka

Powiązane problemy