Killing Javadoc warnings for specific tags

前端 未结 1 1786
离开以前
离开以前 2021-02-19 09:46

Is there an easy way / option of preventing javadoc warnings when building with Maven? We use the soyatec uml plugin for eclipse and it inserts special tags which make our build

1条回答
  •  醉梦人生
    2021-02-19 10:10

    The only answer I could find to this is by Configuring Custom Javadoc Tags.

    An example could be like this:

    
        
            
                org.apache.maven.plugins
                maven-javadoc-plugin
                2.8.1
                
                    
                        
                            uml.property
                            
                            X
                        
                        
                            some.other.property
                            X
                        
                        
                            some.third.property
                            X
                        
                    
                
            
        
    
    

    When running you will see this in the output:

    mvn javadoc:javadoc
    
    
    Note: Custom tags that were not seen:  @uml.property
    
    

    And you can disable non-error and non-warning messages by using this command:

    mvn javadoc:javadoc -Dquiet
    

    It might be a hard job to define all these tags but once done you will no longer see the warnings.

    And you should probably define these custom tags in a parent pom that everyone can use to benefit all the work.

    0 讨论(0)
提交回复
热议问题