¿Cómo puebla el popover Xcode 4 "Opción + clic"?

Question

En Xcode 4, si opción + clic en una palabra clave, entonces dicha palabra clave aparecerá en un popover con un montón de información descriptiva, así:

Sin embargo, cuando opción + clic en mi propio método o variable, lo único que consigue es un enlace al archivo en el que se declaró el objeto:

¿Cómo se hace esto? ¿Puedo aprovechar esto para mi propio código?

(me he dado cuenta de algunos de los encabezados de marco, que hay algún tipo de sintaxis especial comentario. Podría estar relacionado?)

Answer 1

Debe crear su propio "juego de documentación" para su API. Busque en la documentación de Xcode la "Guía del conjunto de documentación" e indague. La sección "Conjuntos de documentación" de la guía establece específicamente que la Ayuda rápida usa esto.

Con un documento establecido en su lugar, esta ventana emergente no solo encontrará la descripción, sino que estará disponible en la Ayuda rápida en el panel de Utilidades así como en el navegador de documentación en el Organizador.

Answer 2

A partir de Xcode 5.0, el formateo de Doxygen y HeaderDoc para variables y métodos se analiza automáticamente y se procesa en el Popover de Ayuda Rápida. Más información sobre el mismo here, pero aquí hay algunos bits de la clave:

/** 
* Add a data point to the data source. 
* (Removes the oldest data point if the data source contains kMaxDataPoints objects.) 
* 
* @param aDataPoint An instance of ABCDataPoint. 
* @return The oldest data point, if any. 
*/ 
- (ABCDataPoint *)addDataToDataSource:(ABCDataPoint *)aDataPoint; 

renders en Xcode como:

cuanto a propiedades, es tan fácil como:

/// Base64-encoded data. 
@property (nonatomic, strong) NSData *data; 

Cuando opción-clic, este adorable popover aparece: