Example of various appledoc commenting styles

ExampleAppledoc.h

//------------------------------
// The method we're documenting:
//------------------------------

- (BOOL)maybeDoWork:(dispatch_block_t)something;

//-------------------------------------------------------------------------------------------

/**
 * @brief You just called me, and this is crazy. But here's a `BOOL`, I did work maybe?
 * @param something Work to be done.
 * @return `YES` if the work was done, `NO` otherwise.
 */

//-------------------------------------------------------------------------------------------

/**
 You just called me, and this is crazy. But here's a `BOOL`, I did work maybe?
 @param something Work to be done.
 @return `YES` if the work was done, `NO` otherwise.
 */

//-------------------------------------------------------------------------------------------