2015-12-02 20 views
6

Attualmente sto lavorando alla creazione di un SDK iOS, scritto in Objective-C. Ora che ho SDK testato e pronto, avrei voluto aggiungere Documentazione combinando Swift e Objective-C. Ho lavorato sui seguenti strumenti del generatore di documentiDocumentazione Objective-C e Swift insieme alla documentazione Apple

a. Doxygen

b. AppleDoc

c. Jazzy

d. HeaderDoc di Apple.

Vorrei utilizzare i commenti nel mio file di intestazione obiettivo-c e generare aiuto combinato per Objective C e Swift simile a come è stato fatto di recente Apple. La mia domanda è come posso generare la documentazione per Swift e Objective-C dalle intestazioni Objective-C?

Ecco alcuni link in base alla mia ricerca:

Grazie,

Ram.

prega di fare riferimento alla documentazione mela qui:

image

+0

Non è chiaro cosa stai chiedendo. Vuoi costruire un'app usando sia Obj-c che swift? Che cos'è quel pezzo di documentazione allora? Perché intendi anche "supportando sia obj-c che swift"? l'obiettivo è iOS. Supporta entrambi. Questo è tutto ciò che c'è – NSNoob

+1

Se vuoi usare i file obj-c in un progetto rapido, dovresti leggerlo. https://developer.apple.com/library/ios/documentation/Swift/Conceptual/BuildingCocoaApps/MixandMatch.html. È possibile – NSNoob

+0

Grazie per la risposta rapida. Voglio generare set di documenti come il modo in cui Apple documenta le sue API che include la documentazione sia per Swift che per Objective-C. Fare riferimento a [qui] (https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSArray_Class/#//apple_ref/occ/instm/NSArray/componentsJoinedByString :) – Ram

risposta

2

Forse non (ancora) esattamente quello che stai cercando, ma è possibile utilizzare Swiftify (https://objectivec2swift.com/) servizio per convertire le dichiarazioni da Objective-C a Swift .

Inoltre, se gli strumenti di documentazione di cui sopra consentono di sviluppare qualsiasi tipo di plug-in con cui integrare, dovrebbe essere possibile generare automaticamente sorgenti Swift usando il nostro Web API.

Potremmo essere disposti a sviluppare tale integrazione se ce ne sarà una richiesta.

Disclaimer: Io sono l'autore di Swiftify :)

+1

Grazie per la preziosa risposta. Ho provato Swiftify. Converte perfettamente il codice Objective-C in Swift ma non la documentazione del codice. Tuttavia, come hai detto se ci sarà una richiesta, conta su di me come entusiasta di aspettare la funzionalità. – Ram