jenkinsci
/
configuration-as-code-plugin
mirror of https://github.com/jenkinsci/configuration-as-code-plugin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix JavaDocs (#136)

This commit is contained in:
Gunnar Bastkowski 2018-03-06 20:47:01 +01:00 committed by Ewelina Wilkosz
parent db35f1a3e9
commit a87e24b0bf
2 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/main/java/org/jenkinsci/plugins/casc/Configurator.java
View File

@ -202,6 +202,7 @@ public abstract class Configurator<T> implements ExtensionPoint {
* Retrieve which plugin do provide this extension point * Retrieve which plugin do provide this extension point
* *
* @return String * @return String
* @throws IOException if config file cannot be saved
*/ */
public String getExtensionSource() throws IOException { public String getExtensionSource() throws IOException {
final Class e = getExtensionPoint(); final Class e = getExtensionPoint();
@ -231,6 +232,7 @@ public abstract class Configurator<T> implements ExtensionPoint {
* a Jenkins object is configured. * a Jenkins object is configured.
* @return * @return
* Fully configured Jenkins object that results from this configuration. * Fully configured Jenkins object that results from this configuration.
* @throws Exception if something went wrong, depends on the concrete implementation
*/ */
public abstract T configure(Object config) throws Exception; public abstract T configure(Object config) throws Exception;
@ -238,7 +240,7 @@ public abstract class Configurator<T> implements ExtensionPoint {
* Ordered version of {@link #describe()} for documentation generation * Ordered version of {@link #describe()} for documentation generation
* *
* @return * @return
* A list of {@Link Attribute}s * A list of {@link Attribute}s
*/ */
public List<Attribute> getAttributes() { public List<Attribute> getAttributes() {
final ArrayList<Attribute> attributes = new ArrayList<>(describe()); final ArrayList<Attribute> attributes = new ArrayList<>(describe());
@ -260,14 +262,16 @@ public abstract class Configurator<T> implements ExtensionPoint {
/** /**
* Determine the list of Attribute available for configuration of the managed component. * Determine the list of Attribute available for configuration of the managed component.
* *
* @return A set of {@Link Attribute}s that describes this object * @return A set of {@link Attribute}s that describes this object
*/ */
public abstract Set<Attribute> describe(); public abstract Set<Attribute> describe();
/** /**
* Retrieve the html help tip associated to an attribute. * Retrieve the html help tip associated to an attribute.
* FIXME would prefer <st:include page="help-${a.name}.html" class="${c.target}" optional="true"/> * FIXME would prefer &lt;st:include page="help-${a.name}.html" class="${c.target}" optional="true"/&gt;
* @param attribute to get help for
* @return String that shows help * @return String that shows help
* @throws IOException if the resource cannot be read
*/ */
public String getHtmlHelp(String attribute) throws IOException { public String getHtmlHelp(String attribute) throws IOException {
final URL resource = getKlass().getResource("help-" + attribute + ".html"); final URL resource = getKlass().getResource("help-" + attribute + ".html");

7
src/main/java/org/jenkinsci/plugins/casc/SecretSource.java
View File

@ -17,12 +17,7 @@ import java.util.regex.Pattern;
* Variable references are meant to hide secrets from configuration files. * Variable references are meant to hide secrets from configuration files.
*/ */
public abstract class SecretSource implements ExtensionPoint { public abstract class SecretSource implements ExtensionPoint {
/**
*
* @param secret
* @return the revealed secret. Null in the case that the implementation is not replacing anything. Throws exception
* if the secret could not be fetched.
*/
public static final Pattern SECRET_PATTERN = Pattern.compile("\\$\\{(.*)\\}"); public static final Pattern SECRET_PATTERN = Pattern.compile("\\$\\{(.*)\\}");
//We need to compile the matcher once for every key we examine. //We need to compile the matcher once for every key we examine.