/**
* Adds a parameter and its description to parametersection of the doc
*
* @param parametername
* @param parameterdescription
*/
private void addParameter(String parametername, String parameterdescription) {
PARAMETER_NAME_TAG.setContent(parametername);
memberParameter.insertTagContent(PARAMETER_NAME_TAG);
PARAMETER_DESCRIPTION_TAG.setContent(parameterdescription);
memberParameter.insertTagContent(PARAMETER_DESCRIPTION_TAG);
PARAMETER_TAG.addContent(memberParameter.getTemplateContent());
}
/**
* Adds all related members of a doc item to the related section of the doc
*
* @param doc
*/
void addRelatedmember(
Doc doc, HashMap<String, String> fieldLinks, HashMap<String, String> methodLinks) {
Tag[] relatedTags = doc.tags("@related");
for (Tag relatedTag : relatedTags) {
String link = "";
if (fieldLinks.containsKey(relatedTag.text())) {
link = fieldLinks.get(relatedTag.text());
} else if (methodLinks.containsKey(relatedTag.text())) {
link = methodLinks.get(relatedTag.text());
} else if (StartDoclet.classLinks.containsKey(relatedTag.text())) {
link = StartDoclet.classLinks.get(relatedTag.text());
} else {
System.out.println("No related member found for @related " + relatedTag.text());
}
StringBuffer relatedBuffer = new StringBuffer();
relatedBuffer.append("<A href=\"");
relatedBuffer.append(link);
relatedBuffer.append(".html\">");
relatedBuffer.append(relatedTag.text());
relatedBuffer.append("</A><BR>\n");
RELATED_TAG.addContent(relatedBuffer.toString());
}
}
/**
* Adds a methods signature to the Syntaxsection of the doc
*
* @param memberSyntaxString Method Signature to add to the Syntaxsection
*/
private void addSyntax(String memberSyntaxString) {
StringBuffer memberSyntaxBuffer = new StringBuffer();
memberSyntaxBuffer.append(memberSyntaxString);
memberSyntaxBuffer.append("\n");
SYNTAX_TAG.addContent(memberSyntaxBuffer.toString());
}
