ios - Show warnings for undocumented methods -


i'm searching ways improve code quality , i'm struggling documentation.

using xcode built-in documentation tool (headerdoc if i'm right), i'd have warnings each undocumented method when building app.

at moment, i'm able show warnings documentation errors enabling "documentation comments" variable in build settings.

is possible, or have use other documentation tool warnings?

edit

here example of want:

in header files

/** * documentation */ -(void) adocumentedcustommethod; // custom method documented : no warning  -(void) anundocumentedcustommethod; // custom method not documented: 1 warning 

in implementation files

/** * documentation */ -(void) adocumentedcustommethod {...} // custom method documented: no warning  -(void) anundocumentedcustommethod {...} // custom method not documented: 1 warning  -(void) viewdidload {...} // sdk method : no warning. 

after studying oclint, may possible write custom rule detec undocumented methods in implementation files. seems tool doesn't analyze header files, means make false-positive methods (those documented in header files instead of implementation files).

in xcode there no option find methods don't have comments.

but there tool available oclint, can integrate xcode , evaluate code quality. can refer following links oclint integration.

  1. installation
  2. customizing rules
  3. tutorials

Comments

Popular posts from this blog

java - Plugin org.apache.maven.plugins:maven-install-plugin:2.4 or one of its dependencies could not be resolved -

Round ImageView Android -

How can I utilize Yahoo Weather API in android -