TongchengOpenSource/smart-doc

Is smart-doc maven plugin support skip without modify pom?

tuichenchuxin opened this issue · 7 comments

tuichenchuxin commented

Summary

Is smart-doc maven plugin support skip without modify pom?

Basic example

mvn clean install -Dsmart-doc:skip=true

Motivation

Make it more convenient to use.

shalousun commented

@tuichenchuxin We can provide support, The user guides should also be added to the official documentation at https://github.com/smart-doc-group/smart-doc-group.github.io.

tuichenchuxin commented

@tuichenchuxin We can provide support, The user guides should also be added to the official documentation at https://github.com/smart-doc-group/smart-doc-group.github.io.

Thank you very much. you say that this guide adds content, do you mean @JavaDoc feature?

shalousun commented

@tuichenchuxin We can provide support, The user guides should also be added to the official documentation at https://github.com/smart-doc-group/smart-doc-group.github.io.

Thank you very much. you say that this guide adds content, do you mean @JavaDoc feature?

  1. There is a descriptive document for smart-doc custom tag. Add the usage description of the javadoc tag.
  2. Update the newly added Mojo of the Maven plugin in the documentation.
  3. Include the usage of skipping Maven plugin support in the documentation as well.
tuichenchuxin commented

@tuichenchuxin We can provide support, The user guides should also be added to the official documentation at https://github.com/smart-doc-group/smart-doc-group.github.io.

Thank you very much. you say that this guide adds content, do you mean @JavaDoc feature?

  1. There is a descriptive document for smart-doc custom tag. Add the usage description of the javadoc tag.
  2. Update the newly added Mojo of the Maven plugin in the documentation.
  3. Include the usage of skipping Maven plugin support in the documentation as well.

OK, I'll add document of javadoc

tuichenchuxin commented

@shalousun about support skip, if you have some idea, I can also make some contribution.

shalousun commented

@shalousun about support skip, if you have some idea, I can also make some contribution.

The current smart-doc-maven has a skip configuration, but the naming is not very distinctive. It can be modified to @Parameter(property = "smartdoc.skip") private String skip; so that when using the command, it can become mvn clean install -Dsmartdoc.skip=true.

tuichenchuxin commented

@shalousun about support skip, if you have some idea, I can also make some contribution.

The current smart-doc-maven has a skip configuration, but the naming is not very distinctive. It can be modified to @Parameter(property = "smartdoc.skip") private String skip; so that when using the command, it can become mvn clean install -Dsmartdoc.skip=true.

Great, I'll support this.