[MPLUGIN-426] add @Description annotation #152
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| package org.apache.maven.plugins.annotations; | ||
|
|
||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import java.lang.annotation.Documented; | ||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Inherited; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| /** | ||
| * Describes a {@code Mojo} or a Mojo’s {@code Parameter} when JavaDoc extraction is not feasible (because of deviating | ||
| * documentation goals) or not possible (e.g. for other JVM languages like Scala, Groovy or Kotlin). | ||
| */ | ||
| @Documented | ||
| @Retention( RetentionPolicy.CLASS ) | ||
| @Target( { ElementType.TYPE, ElementType.FIELD } ) | ||
| @Inherited | ||
| public @interface Description | ||
| { | ||
| /** | ||
| * Description content for the {@code Mojo} or Mojo {@code Parameter}. | ||
| * | ||
| * <p>A "Safe HTML" subset can be used. This is achieved by running | ||
| * the content through the <a href="https://github.com/owasp/java-html-sanitizer"<OWASP Java HTML Sanitizer</a> | ||
| * before rendering.</p> | ||
| * | ||
| * @return a description of the Mojo or the parameter. | ||
| */ | ||
| String content(); | ||
|
|
||
| /** | ||
| * The version of the plugin since when this goal or parameter was introduced (inclusive, optional). | ||
| * | ||
| * @return The version of the plugin since when this goal or parameter was introduced (inclusive) or an empty string | ||
| * of no since version has been given. | ||
| */ | ||
| String since() default ""; | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| package org.apache.maven.tools.plugin.extractor.annotations.datamodel; | ||
|
|
||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import java.util.StringJoiner; | ||
|
|
||
| /** | ||
| * @author Benjamin Marwell | ||
| * @since 3.7.0 | ||
| */ | ||
| public class DescriptionAnnotationContent | ||
| { | ||
|
|
||
| private String content; | ||
|
|
||
| private String since; | ||
|
|
||
| public String getContent() | ||
| { | ||
| return content; | ||
| } | ||
|
|
||
| public void setContent( String content ) | ||
| { | ||
| this.content = content; | ||
| } | ||
|
|
||
| public String getSince() | ||
| { | ||
| return since; | ||
| } | ||
|
|
||
| public void setSince( String since ) | ||
| { | ||
| this.since = since; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() | ||
| { | ||
| return new StringJoiner( ", ", DescriptionAnnotationContent.class.getSimpleName() + "[", "]" ) | ||
| .add( "content='" + content + "'" ) | ||
| .add( "since='" + since + "'" ) | ||
| .toString(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Naming?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With this named as
value, could annotation be used as@Description("xxx yyy")?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, that was my first idea. But since it contains HTML, I thought it might be a good idea to not use "value". But then, what would value be if added later...
Can change that. Will also add tests.