tomaz/appledoc — Issue #161: @todo directive
Author: dented42
Created: 2011-12-23 02:08:39+00:00
State: open

it would be nice to have some sort of 'todo' declaration with that would cause a warning to be generated in the output log, similar to when an undocumented member is encountered and --keep-undocumented-members is set.

I'm using a shell script build phase and the Xcode log format so that Xcode tells me when I've missed documenting an item. I can put a large TODO in all caps (or something similar) so that when I read the header later I will remember to fill in a missing paragraph, but it would be nice to have a warning generated so that when I build my library, I see all such similar warning in a single place.

The idea is that I'd do something like:
```
/**
* Long introduction paragraph about a class.
*
* @todo explain super special awesome feature #31
*/
@interface MECoolThing : NSOjbect {
// ...
}
// ...
@end
```
and the todo would show up as a warning.