Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Idas Documentation Todo

This list represents documentation items needing to be done.

Generated from tasks in code
Description Resource In Folder Location
Add comments. Specifically regarding the mutability of _value BasicProperty.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas/impl line 22
Describe format in more detail. Give examples. IContextFactory.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 53
Describe format in more detail. Give examples. IContextFactory.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 61
Discuss collisions. IContext.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 108
Discuss transactional semantics. Is this guaranteed to fully succeed or fully fail? IContext.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 183
discuss whether modifications to the returned IDigitalSubject affect the stored subject.

IContext.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 125
If this method also adds, note that updates to the returned {@link IRelationship} affect the added relationship.<p> IHasRelationships.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 27
If this method also adds, note that updates to the returned IMetadata affect the added item (i.e. a reference, not a copy is stored).<p> IHasMetadata.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 30
Specify format type. Give example IContext.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 98
Specify format type. Give example IContext.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 110
Specify whether this also adds the produced IMetadata to this Object, or if addItem must subsequently be called.<p> IHasMetadata.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 29
Specify whether this also adds the relationship to this Object, or if add must subsequently be called.<p> IHasRelationships.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 26
Talk about what's required to make this work -- how factories are registered and referenced in the Higgins system.<p> IContextFactory.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 18
Add (or point at) doc which explains relationship types. IRelationship.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 27
Add (or point to) documentation which includes sample schema.<p> IContext.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 77
Add (or point to) doc which explains metadata. IHasMetadata.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 18
Add (or point to) doc which explains what metadata is and how it's used<p> IMetadata.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 15
Add example types. Possibly some that denote hierarchy (parent, child, sibling). IRelationship.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 28
add example URI to a higgins person. IContext.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 151
add javadoc to methods. IRelationship.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 18
Add pointers to OWL.<p> IContext.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 76
add reference), This interface represents an attribute of a DigitalSubject.<p> IAttribute.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 15
Finish commenting methods. IContextFactory.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 19
Finish javadoc for methods IMetadata.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 17
Finish javadoc on methods IDigitalSubject.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 16
give example. IHasRelationships.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 28
Show an example (preferably that of an owner or source for the object to which some metadata is attached) IMetadata.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 16
We decided to make the type be a String rather than IDigitalSubject.java org.eclipse.higgins.idas/src/org/eclipse/higgins/idas line 40

Back to the top