Skip to content

XDOC: document required fields in generated model docs #550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
slachiewicz wants to merge 1 commit into
base: master
Choose a base branch
from
Open

XDOC: document required fields in generated model docs #550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ...ins/modello-plugin-xdoc/src/main/java/org/codehaus/modello/plugin/xdoc/XdocGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,10 @@ private void writeFieldsTable(XMLWriter w, List<ModelField> fields, boolean elem

w.writeMarkup(getDescription(f));

if (f.isRequired()) {
w.writeMarkup("<p><strong>Required</strong>: Yes.</p>");
}

// Write the default value, if it exists.
// But only for fields that are not a ModelAssociation
if (f.getDefaultValue() != null && !(f instanceof ModelAssociation)) {
Expand Down
10 changes: 10 additions & 0 deletions ...modello-plugin-xdoc/src/test/java/org/codehaus/modello/plugin/xdoc/XdocGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,16 @@ private void checkMavenXdocGenerator() throws Exception {

// verify( "org.codehaus.modello.generator.xml.cdoc.XdocVerifier", "xdoc" );
checkInternalLinks("maven.xml");

String content = FileUtils.fileRead(new File(getOutputDirectory(), "maven.xml"), "UTF-8");

Pattern requiredModelVersion =
Pattern.compile("<code>modelVersion</code>.*?<strong>Required</strong>: Yes\\.", Pattern.DOTALL);
assertTrue(requiredModelVersion.matcher(content).find(), "Required modelVersion field should be documented");

Pattern requiredGroupId =
Pattern.compile("<code>groupId</code>.*?<strong>Required</strong>: Yes\\.", Pattern.DOTALL);
assertTrue(requiredGroupId.matcher(content).find(), "Required groupId field should be documented");
}

public void checkFeaturesXdocGenerator() throws Exception {
Expand Down