Rename linked list functions that are overlapping or are too generic

[simantics/platform.git] / bundles / org.simantics.scl.db / scl / Simantics / DB.md

diff --git a/bundles/org.simantics.scl.db/scl/Simantics/DB.md b/bundles/org.simantics.scl.db/scl/Simantics/DB.md
index dd6e5d0bccf51f7453077bd71e438b76e1440610..d51ecddd8977de485193dade48f218dc19ed3bc7 100644 (file)
--- a/bundles/org.simantics.scl.db/scl/Simantics/DB.md
+++ b/bundles/org.simantics.scl.db/scl/Simantics/DB.md
@@ -1,111 +1,118 @@
-# DB module documentation\r
-\r
-::data[Resource]\r
-\r
-## Reading\r
-\r
-### URIs\r
-\r
-::value[resource, possibleResource, relativeResource]\r
-\r
-### Graph hierarchy\r
-\r
-::class[Browsable]\r
-\r
-### Objects\r
-\r
-::value[#, singleObject, possibleObject]\r
-::value[objectsWithType]\r
-\r
-### Statements\r
-\r
-::data[Statement]\r
-::value[subjectOf, predicateOf, objectOf]\r
-::value[statements, singleStatement]\r
-\r
-### Special objects\r
-\r
-::value[singleTypeOf, possibleTypeOf]\r
-::value[inverseOf]\r
-\r
-### Literals\r
-\r
-::value[relatedValue, possibleRelatedValue]\r
-::value[relatedValue2]\r
-::value[untypedValueOf, untypedRelatedValue, untypedPossibleRelatedValue]\r
-\r
-### Predicates\r
-\r
-::value[isInstanceOf, isSubrelationOf, isInheritedFrom, isParent]\r
-::value[existsStatement, existsStatement3]\r
-\r
-### Special resources\r
-\r
-::value[currentModel, currentProject, getRootLibrary, listOntologies]\r
-\r
-### Resource id\r
-\r
-::value[resourceId, resourceFromId]\r
-\r
-## Writing\r
-\r
-### Adding statements\r
-\r
-::value[newResource]\r
-::value[claim]\r
-::value[deny, denyByPredicate, denyAllStatements]\r
-::value[claimAssertion]\r
-\r
-### Writing literals\r
-\r
-::value[claimRelatedValue, claimRelatedValueWithType]\r
-::value[untypedClaimRelatedValue]\r
-::value[denyValue]\r
-\r
-## Ordered sets\r
-\r
-::value[addToOrderedSet]\r
-::value[setOrderedSet]\r
-::value[elementsOfOrderedSet]\r
-::value[parentOrderedSet]\r
-\r
-## Transactions\r
-\r
-::value[syncRead, asyncRead]\r
-::value[syncWrite, asyncWrite]\r
-::value[virtualSyncWriteMem, virtualSyncWriteWS] \r
-::value[lift1Read, lift2Read, lift3Read]\r
-::value[lift1Write, lift2Write, lift3Write]\r
-::value[addCommentMetadata]\r
-::value[makeSynchronous]\r
-::value[enableDependencies, disableDependencies]\r
-\r
-## Undo\r
-\r
-::value[markUndoPoint, startUndoPoint]\r
-::value[undo, redo, undoOperations]\r
-\r
-## Generation of resource names\r
-\r
-::value[findFreshName, findFreshEscapedName]\r
-\r
-## Helper functions for handling URIs\r
-\r
-::value[escapeURI, unescapeURI, splitURI]\r
-\r
-## Structured graph writing\r
-\r
-::value[newEntity]\r
-::value[hasStatement, hasName, hasType, hasLabel, hasProperty, hasTypedProperty, hasPossibleProperty, hasParent]\r
-\r
-## Clusters\r
-\r
-::value[newClusterSet, selectClusterSet, sortByCluster]\r
-\r
-## Debugging\r
-\r
-::value[queryDebugSupport, queryListSupport]\r
-\r
-## Miscellaneous functions\r
-\r
+# DB module documentation
+
+::data[Resource]
+
+## Reading
+
+### URIs
+
+::value[resource, possibleResource, relativeResource]
+
+### Graph hierarchy
+
+::class[Browsable]
+
+### Objects
+
+::value[#, singleObject, possibleObject]
+::value[objectsWithType]
+
+### Statements
+
+::data[Statement]
+::value[subjectOf, predicateOf, objectOf]
+::value[statements, singleStatement]
+
+### Special objects
+
+::value[singleTypeOf, possibleTypeOf]
+::value[inverseOf]
+
+### Literals
+
+::value[relatedValue, possibleRelatedValue]
+::value[relatedValue2]
+::value[untypedValueOf, untypedRelatedValue, untypedPossibleRelatedValue]
+
+### Predicates
+
+::value[isInstanceOf, isSubrelationOf, isInheritedFrom, isParent]
+::value[existsStatement, existsStatement3]
+
+### Special resources
+
+::value[currentModel, currentProject, getRootLibrary, listOntologies]
+
+### Resource id
+
+::value[resourceId, resourceFromId]
+
+## Writing
+
+### Adding statements
+
+::value[newResource]
+::value[claim]
+::value[deny, denyByPredicate, denyAllStatements]
+::value[claimAssertion]
+
+### Writing literals
+
+::value[claimRelatedValue, claimRelatedValueWithType]
+::value[untypedClaimRelatedValue]
+::value[denyValue]
+
+## Ordered sets
+
+::value[addToOrderedSet,addFirstToOrderedSet,addAfterToOrderedSet,addBeforeToOrderedSet]
+::value[removeFromOrderedSet]
+::value[setOrderedSet]
+::value[elementsOfOrderedSet]
+::value[parentOrderedSet]
+
+## Linked List
+
+::value[elementsOfList,createList,createListWithType]
+::value[insertListBack,insertListFront,removeListElement]
+::value[swapListElementWithPrevious,swapListElementWithNext]
+
+## Transactions
+
+::value[syncRead, asyncRead]
+::value[syncWrite, asyncWrite]
+::value[virtualSyncWriteMem, virtualSyncWriteWS] 
+::value[lift1Read, lift2Read, lift3Read]
+::value[lift1Write, lift2Write, lift3Write]
+::value[addCommentMetadata]
+::value[makeSynchronous]
+::value[enableDependencies, disableDependencies]
+
+## Undo
+
+::value[markUndoPoint, startUndoPoint]
+::value[undo, redo, undoOperations]
+
+## Generation of resource names
+
+::value[findFreshName, findFreshEscapedName]
+
+## Helper functions for handling URIs
+
+::value[escapeURI, unescapeURI, splitURI]
+
+## Structured graph writing
+
+::value[newEntity]
+::value[hasStatement, hasName, hasType, hasLabel, hasProperty, hasTypedProperty, hasPossibleProperty, hasParent]
+
+## Clusters
+
+::value[newClusterSet, selectClusterSet, sortByCluster]
+
+## Debugging
+
+::value[queryDebugSupport, queryListSupport]
+
+## Miscellaneous functions
+
 ::undocumented[]
\ No newline at end of file