Come funziona la nuova analisi della documentazione di Xcode 5?

Question

Ho notato che Xcode 5 ora analizza automaticamente la documentazione del metodo. Per esempio:

/** 
Fetches a conversation with user. 

@param user The other user in the conversation. 

@return A conversation 
*/ 
+ (Conversation *)conversationWithUser:(User *)user; 

Esso supporta più @ gettoni (non so come chiamare loro). Per esempio:

• @warning
• @note

Tuttavia, non ho ancora trovato un modo o in quale formato si tratta, in modo che posso aggiungere grassetto testo o corsivo o collegamenti.

Qualcuno sa quale formato di documentazione è?

Answer 1

Secondo le nuove funzioni di XCode 5 (Under Documentazione):

Documentazione del progetto dalla documentazione quadro di riferimento API e commenti strutturati nel codice sorgente propria vengono visualizzate nel pannello di aiuto rapido e nel codice visualizzazioni popover di completamento. I commenti strutturati Doxygen e HeaderDoc sono formati supportati.

È possibile controllare il Header Doc User guide.

Apparentemente, utilizza un sottoinsieme di queste funzionalità, molte delle quali non funzionano.

Answer 2

Non è completo. Al momento non supporta tutti i tag Doxygen, solo un sottoinsieme di base.

Nel frattempo, è possibile utilizzare le bandiere come -Wdocumentation e -Wdocumentation-unknown-command (o meglio, iniziamo con -Weverything e ridurre), e clang vi comunicheremo se incontra qualcosa che è riconosciuto o malformati. Se vuoi un elenco completo di quali tag sono disponibili, vorrei controllare il bagagliaio.

Answer 3

Ho scoperto come ottenere grassetto e corsivo. Utilizza this Doxygen format. Non sembra di riconoscere tutti i comandi, ma alcuni lavori:

/** 
Resumes \b network operation queues. 
*/ 
- (void)resume; 

Il \b ci sarebbe fare rete in grassetto. \a produce il corsivo e il testo a spaziatura fissa \c.