| Inherits from | GBParagraphItem : NSObject |
| Declared in | GBParagraphLinkItem.h<br />GBParagraphLinkItem.m |
Specifies a link paragraph item.
Link items wrap a cross reference link with all the data. There are several types of links:
stringValue value represents the link value, while all other properties are nil . isLocal is NO . stringValue value represents nicely formatted object's name and context points to the object instance while all other properties are nil and isLocal is either YES if the link's origin is the same object or NO if it's a link to another object. stringValue value represents nicely formatted link value, context points to the object instance and member to the object's member instance. isLocal value is YES . isLocal value is NO in this case. href
The href value to which the link "points" to.
context
The context to which the link's member points to or nil if this is a stringValue link.
member
The member to which the link points to or nil if this is either a stringValue link or context link.
isLocal
Specifies whether the link is local or not.
@property (retain) id context The context to which the link's member points to or nil if this is a stringValue link.
The context can be either GBClassData , GBCategoryData or GBProtocolData if provided.
GBParagraphLinkItem.hThe href value to which the link "points" to.
@property (retain) NSString *hrefThe href value to which the link "points" to.
This can actually be used when generating output to get proper URL of the link item.
GBParagraphLinkItem.hSpecifies whether the link is local or not.
@property (assign) BOOL isLocalSpecifies whether the link is local or not.
If a link is local, it points from within a context either to the context itself (i.e. member is nil ) or to on eof the the same context s members. If the link points to another context or to one of other context s member , or this is a stringValue link, the value is NO .
GBParagraphLinkItem.h@property (retain) id member The member to which the link points to or nil if this is either a stringValue link or context link.
This is only used if the link points to a member within a context . If this is link to the context itself or to an stringValue , this value is nil . The member can only be a GBMethodData instance at this point.
GBParagraphLinkItem.h