io.github.prolobjectlink.prolog

Interface PrologDocumentable

All Known Subinterfaces:

PrologClause

All Known Implementing Classes:

AbstractClause

public interface PrologDocumentable

Since:

1.1

Author:

Jose Zalacain

Method Summary

Modifier and Type	Method and Description
String	getAuthor() Get the author tag in doc comment
String	getDescription() Get the description tag in doc comment
String	getSee() Get the see tag in doc comment
String	getSince() Get the since tag in doc comment
String	getVersion() Get the version tag in doc comment
boolean	hasAuthor() Check if exist author tag in doc comment
boolean	hasDescription() Check if exist description tag in doc comment
boolean	hasDocumentation() Check if exist at least one tag like documentation comment
boolean	hasSee() Check if exist see tag in doc comment
boolean	hasSince() Check if exist since tag in doc comment
boolean	hasVersion() Check if exist version tag in doc comment
void	setAuthor(String author) Set the author tag in doc comment
void	setDescription(String description) Set the description tag in doc comment
void	setSee(String see) Set the see tag in doc comment
void	setSince(String since) Set the since tag in doc comment
void	setVersion(String version) Set the version tag in doc comment

Method Detail

hasDocumentation

boolean hasDocumentation()

Check if exist at least one tag like documentation comment

Since:

1.2

hasDescription

boolean hasDescription()

Check if exist description tag in doc comment

Since:

1.2

hasVersion

boolean hasVersion()

Check if exist version tag in doc comment

Since:

1.2

hasAuthor

boolean hasAuthor()

Check if exist author tag in doc comment

Since:

1.2

hasSince

boolean hasSince()

Check if exist since tag in doc comment

Since:

1.2

hasSee

boolean hasSee()

Check if exist see tag in doc comment

Since:

1.2

setDescription

void setDescription(String description)

Set the description tag in doc comment

Parameters:

description - description for this doc object

Since:

1.2

setVersion

void setVersion(String version)

Set the version tag in doc comment

Parameters:

version - version for this doc object

Since:

1.2

setAuthor

void setAuthor(String author)

Set the author tag in doc comment

Parameters:

author - author for this doc object

Since:

1.2

setSince

void setSince(String since)

Set the since tag in doc comment

Parameters:

since - since for this doc object

Since:

1.2

setSee

void setSee(String see)

Set the see tag in doc comment

Parameters:

see - see for this doc object

Since:

1.2

getDescription

String getDescription()

Get the description tag in doc comment

Since:

1.2

getVersion

String getVersion()

Get the version tag in doc comment

Since:

1.2

getAuthor

String getAuthor()

Get the author tag in doc comment

Since:

1.2

getSince

String getSince()

Get the since tag in doc comment

Since:

1.2

getSee

String getSee()

Get the see tag in doc comment

Since:

1.2