public class SComment extends Object
Modifier and Type | Field and Description |
---|---|
static int |
ATTRIBUTE
Marks a comment as belonging to an attribute.
|
static int |
ELEMENT
Marks a comment as belonging to an element
|
static int |
GENERAL_ENTITY
Marks a comment that applies to a general entity definition.
|
static int |
MODULE
Marks a comment as belonging to an individual module.
|
static int |
PARAMETER_ENTITY
Marks a comment that applies to a parameter entity definition.
|
Constructor and Description |
---|
SComment(String identifier)
Creates a new instance of an SComment.
|
Modifier and Type | Method and Description |
---|---|
void |
addSection(String name,
String text)
Add a new section to this structured comment.
|
String |
convertMarkdown(String s)
This method takes care of converting a structure comment section into Markdown.
|
String |
getName() |
String |
getSection(String name) |
Iterator |
getSectionNameIterator()
Returns an iterator of all the names of the sections in this structured
comment
|
String |
getTitle() |
int |
getType() |
boolean |
isRoot()
Returns true if this structured comment includes a tag "root"
|
static void |
setCommentProcessor(String p)
Sets the structured comment processor for this class.
|
void |
setName(String n) |
public static final int PARAMETER_ENTITY
public static final int GENERAL_ENTITY
public static final int MODULE
public static final int ELEMENT
public static final int ATTRIBUTE
public SComment(String identifier)
public int getType()
public void setName(String n)
public String getTitle()
public String getName()
public void addSection(String name, String text) throws Exception
Exception
public String convertMarkdown(String s)
public Iterator getSectionNameIterator()
public static void setCommentProcessor(String p)
public boolean isRoot()