diff --git a/modello-plugins/modello-plugin-xdoc/src/main/java/org/codehaus/modello/plugin/xdoc/XdocGenerator.java b/modello-plugins/modello-plugin-xdoc/src/main/java/org/codehaus/modello/plugin/xdoc/XdocGenerator.java index c9746bf43..9fceef8d6 100644 --- a/modello-plugins/modello-plugin-xdoc/src/main/java/org/codehaus/modello/plugin/xdoc/XdocGenerator.java +++ b/modello-plugins/modello-plugin-xdoc/src/main/java/org/codehaus/modello/plugin/xdoc/XdocGenerator.java @@ -417,6 +417,10 @@ private void writeFieldsTable(XMLWriter w, List fields, boolean elem w.writeMarkup(getDescription(f)); + if (f.isRequired()) { + w.writeMarkup("

Required: Yes.

"); + } + // Write the default value, if it exists. // But only for fields that are not a ModelAssociation if (f.getDefaultValue() != null && !(f instanceof ModelAssociation)) { diff --git a/modello-plugins/modello-plugin-xdoc/src/test/java/org/codehaus/modello/plugin/xdoc/XdocGeneratorTest.java b/modello-plugins/modello-plugin-xdoc/src/test/java/org/codehaus/modello/plugin/xdoc/XdocGeneratorTest.java index 09f5e4745..bfb9b0a00 100644 --- a/modello-plugins/modello-plugin-xdoc/src/test/java/org/codehaus/modello/plugin/xdoc/XdocGeneratorTest.java +++ b/modello-plugins/modello-plugin-xdoc/src/test/java/org/codehaus/modello/plugin/xdoc/XdocGeneratorTest.java @@ -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("modelVersion.*?Required: Yes\\.", Pattern.DOTALL); + assertTrue(requiredModelVersion.matcher(content).find(), "Required modelVersion field should be documented"); + + Pattern requiredGroupId = + Pattern.compile("groupId.*?Required: Yes\\.", Pattern.DOTALL); + assertTrue(requiredGroupId.matcher(content).find(), "Required groupId field should be documented"); } public void checkFeaturesXdocGenerator() throws Exception {