org.docgene.model

Class XMLDoxygenAPI

java.lang.Object

org.docgene.model.AbstractLink

org.docgene.model.AbstractAPI

org.docgene.model.XMLDoxygenAPI

All Implemented Interfaces:

org.docgene.model.ElementReference, org.docgene.model.ExternalLink, ParagraphElement, StyledElement

public class XMLDoxygenAPI
extends org.docgene.model.AbstractAPI

Represent an link to a Doxygen API.

Field Summary

Fields

Modifier and Type	Field and Description
static short	API_ATTRIBUTE A link to an attribute.
static short	API_CLASS A link to a class.
static short	API_METHOD A link to a method.
static short	API_STRUCT A link to a struct.

Fields inherited from class org.docgene.model.AbstractAPI

altPath, altText, api, isResolved, location, member, path, text, url

Fields inherited from class org.docgene.model.AbstractLink

isAbsolute, isValid

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLDoxygenAPI(java.lang.String api) Create a Doxygen API link.
XMLDoxygenAPI(java.net.URL location) Create a Doxygen API link.

Method Summary

Modifier and Type	Method and Description
short	getAPIType() Return the API type.
java.lang.String	getDeclaration() Return the declaration ID of the element.
void	setAPIType(short type) Set the API type.

Methods inherited from class org.docgene.model.AbstractAPI

bind, bind, getAltPath, getAltText, getAPI, getAPILocation, getMember, getMemberPath, getPath, getShownPath, getText, getURL, hasAPI, hasAPILocation, isConstructor, isResolved, setAltPath, setConstructor, setMember, setMember, setPath

Methods inherited from class org.docgene.model.AbstractLink

getCustomStyles, getLineNumber, isAbsolute, isValid, setCustomStyles, setLineNumber, setValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.docgene.model.ExternalLink

getNotNullURL, getURLAsString, getURLAsString, getURLAsString

Methods inherited from interface org.docgene.model.StyledElement

getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Field Detail

API_CLASS

public static final short API_CLASS

A link to a class.

See Also:

Constant Field Values

API_METHOD

public static final short API_METHOD

A link to a method.

See Also:

Constant Field Values

API_STRUCT

public static final short API_STRUCT

A link to a struct.

See Also:

Constant Field Values

API_ATTRIBUTE

public static final short API_ATTRIBUTE

A link to an attribute.

See Also:

Constant Field Values

Constructor Detail

XMLDoxygenAPI

public XMLDoxygenAPI(java.lang.String api)

Create a Doxygen API link.

Parameters:

api - the Doxygen API

See Also:

APILocations.getDoxygenAPIs()

XMLDoxygenAPI

public XMLDoxygenAPI(java.net.URL location)

Create a Doxygen API link.

Parameters:

location - the location

Method Detail

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Returns:

the declaration ID of the element

setAPIType

public void setAPIType(short type)

Set the API type.

Parameters:

type - the API type

getAPIType

public short getAPIType()

Return the API type.

Returns:

the API type