/**
* Build the field documentation.
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
*/
public void buildFieldDoc(XMLNode node, Content memberDetailsTree) {
if (writer == null) {
return;
}
int size = fields.size();
if (size > 0) {
Content fieldDetailsTree = writer.getFieldDetailsTreeHeader(classDoc, memberDetailsTree);
for (currentFieldIndex = 0; currentFieldIndex < size; currentFieldIndex++) {
Content fieldDocTree =
writer.getFieldDocTreeHeader(
(FieldDoc) fields.get(currentFieldIndex), fieldDetailsTree);
buildChildren(node, fieldDocTree);
fieldDetailsTree.addContent(
writer.getFieldDoc(fieldDocTree, (currentFieldIndex == size - 1)));
}
memberDetailsTree.addContent(writer.getFieldDetails(fieldDetailsTree));
}
}
/** Build the overall footer. */
public void buildFooter() {
writer.writeFooter(classDoc);
}
/** Build the footer for the individual field. */
public void buildFieldFooter() {
writer.writeFieldFooter();
}
/** Build the tag information. */
public void buildTagInfo() {
writer.writeTags((FieldDoc) fields.get(currentFieldIndex));
}
/**
* Build the comments for the field. Do nothing if {@link Configuration#nocomment} is set to true.
*/
public void buildFieldComments() {
if (!configuration.nocomment) {
writer.writeComments((FieldDoc) fields.get(currentFieldIndex));
}
}
/** Build the deprecation information. */
public void buildDeprecationInfo() {
writer.writeDeprecated((FieldDoc) fields.get(currentFieldIndex));
}
/** Build the signature. */
public void buildSignature() {
writer.writeSignature((FieldDoc) fields.get(currentFieldIndex));
}
/** Build the header for the individual field. */
public void buildFieldHeader() {
writer.writeFieldHeader((FieldDoc) fields.get(currentFieldIndex), currentFieldIndex == 0);
}
/** Build the overall header. */
public void buildHeader() {
writer.writeHeader(classDoc, configuration.getText("doclet.Field_Detail"));
}
/**
* Build the tag information.
*
* @param node the XML element that specifies which components to document
* @param fieldDocTree the content tree to which the documentation will be added
*/
public void buildTagInfo(XMLNode node, Content fieldDocTree) {
writer.addTags((FieldDoc) fields.get(currentFieldIndex), fieldDocTree);
}
/**
* Build the comments for the field. Do nothing if {@link Configuration#nocomment} is set to true.
*
* @param node the XML element that specifies which components to document
* @param fieldDocTree the content tree to which the documentation will be added
*/
public void buildFieldComments(XMLNode node, Content fieldDocTree) {
if (!configuration.nocomment) {
writer.addComments((FieldDoc) fields.get(currentFieldIndex), fieldDocTree);
}
}
/**
* Build the deprecation information.
*
* @param node the XML element that specifies which components to document
* @param fieldDocTree the content tree to which the documentation will be added
*/
public void buildDeprecationInfo(XMLNode node, Content fieldDocTree) {
writer.addDeprecated((FieldDoc) fields.get(currentFieldIndex), fieldDocTree);
}
/**
* Build the signature.
*
* @param node the XML element that specifies which components to document
* @param fieldDocTree the content tree to which the documentation will be added
*/
public void buildSignature(XMLNode node, Content fieldDocTree) {
fieldDocTree.addContent(writer.getSignature((FieldDoc) fields.get(currentFieldIndex)));
}