JAutodoc on and off tags

Help
2012-05-14
2013-04-17
  • Bill Fenlason
    Bill Fenlason
    2012-05-14

    Is there a way to selectively turn the JAutodoc processing on and off with some kind of on and off tags?

    I like to JAutodoc the whole document, but when it processes an enum, it adds things which I think are inappropriate.  For Example:
     
      /**
       * The Enum Context.
       */
      public enum Context {

    //    @formatter:off
       
        /** The BEGI n_ state. */
    BEGIN_STATE,

    As you can see, I tried the Java editor formatting tags but they don't seem to work.  Am I missing something simple?
    Thanks.

     
  • Martin Kesting
    Martin Kesting
    2012-05-21

    On and off tags are not supported. You can get a better result, if you create your own template for the enum values.

    Create a field template like this:

    Name:

    Constant
    

    Pattern:

     [A-Z_]+
    

    Example:

    BEGIN_STATE
    

    Template:

    /**
     * Value for ${e.toString().toLowerCase().replaceAll('_',' ')}.
     */
    

    Does this solve your problem?

     
  • Bill Fenlason
    Bill Fenlason
    2012-05-21

    Thanks for the suggestion - it will partially solve my problem.

    I hope you will consider supporting some form of on-off tags.  For example, I may want to have JAutodoc processing on some enums and not others, etc.  On-off tags would prevent me from having to go back and delete JAutodoc generated things where I don't want them.

    Thanks again for the response.