/ doc / toc / ARCDoc / Class / Documentator

Documentator

Edit keys at this level only

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

__TOCDet/Assembly = ARCDoc
__TOCDet/Description = General class for documenting AgoRapide and also your own -ApplicationSpecificCode-.0x000D0x000A0x000D0x000ASee also -DocumentatorP-.0x000D0x000A0x000D0x000AHINT: If you want to test concepts like -PropertyStream- and -CoreDB- then this class is a good generator of properties for the stream. Just call -ToPropertyStream- on root storage and you will have a quite sizeable chunk of property stream lines available for testing.
__TOCDet/DocFragType = Class
__TOCDet/Name = Documentator
__TOCDet/Namespace = ARCDoc
__TOCDet/Type = Documentator
__TOCDet/Attribute/AssemblyName = ARCDoc
__TOCDet/Attribute/BaseTypes = PRich
__TOCDet/Attribute/ClassNamespace = ARCDoc
__TOCDet/Attribute/ClassType = Documentator
__TOCDet/Attribute/CorrespondingEnumType = DocumentatorP
__TOCDet/Attribute/Description = General class for documenting AgoRapide and also your own -ApplicationSpecificCode-.0x000D0x000A0x000D0x000ASee also -DocumentatorP-.0x000D0x000A0x000D0x000AHINT: If you want to test concepts like -PropertyStream- and -CoreDB- then this class is a good generator of properties for the stream. Just call -ToPropertyStream- on root storage and you will have a quite sizeable chunk of property stream lines available for testing.
__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
CreateAndInsert/__TOCDet/Assembly = ARCDoc
CreateAndInsert/__TOCDet/Description = Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.0x000D0x000A0x000D0x000AInserts this representation in the given root data storage parameter under the -doc- key.0x000D0x000A(this means that actual returned value is most probably not consumed by caller).0x000D0x000AThe reason for this somewhat curious behaviour is for -HLocationCollection-.-Create- to work.0x000D0x000ACreates documentation for your application based on attributes like -ClassAttribute-, -ClassMemberAttribute-, -EnumAttribute-,0x000D0x000A-EnumMemberAttribute-,0x000D0x000A-PKTypeAttribute-,0x000D0x000A-PKLogAttribute- -PKRelAttribute- -PKHTMLAttribute- and so on0x000D0x000A0x000D0x000ANote how documentation will include both -ApplicationSpecificCode- and -StandardAgoRapideCode- (as long as parameter assemblies contain the relevant assemblies).0x000D0x000AHint: Limit parameter 'assemblies' to only those assemblies containing your -ApplicationSpecificCode- in order to have documentation of only your application, without the AgoRapide library documentation 'coming in the way'.0x000D0x000A0x000D0x000ANote: If you want to publish the resulting data to -PropertyStream- you should prefix the data with -doc-.0x000D0x000A0x000D0x000AThe parameter specialPrefixes contains prefixes for which links are also desired for potential links without the prefix.0x000D0x000ASee -ARCQuery-.-QUtil- for example of use.0x000D0x000A0x000D0x000A
CreateAndInsert/__TOCDet/DocFragType = ClassMember
CreateAndInsert/__TOCDet/IsInherited = False
CreateAndInsert/__TOCDet/IsInheritedDoc = False
CreateAndInsert/__TOCDet/Lines = 19
CreateAndInsert/__TOCDet/Name = CreateAndInsert
CreateAndInsert/__TOCDet/Namespace = ARCDoc
CreateAndInsert/__TOCDet/Type = Documentator
CreateAndInsert/__TOCDet/Attribute/DeclaringType = Documentator
CreateAndInsert/__TOCDet/Attribute/Description = Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.0x000D0x000A0x000D0x000AInserts this representation in the given root data storage parameter under the -doc- key.0x000D0x000A(this means that actual returned value is most probably not consumed by caller).0x000D0x000AThe reason for this somewhat curious behaviour is for -HLocationCollection-.-Create- to work.0x000D0x000ACreates documentation for your application based on attributes like -ClassAttribute-, -ClassMemberAttribute-, -EnumAttribute-,0x000D0x000A-EnumMemberAttribute-,0x000D0x000A-PKTypeAttribute-,0x000D0x000A-PKLogAttribute- -PKRelAttribute- -PKHTMLAttribute- and so on0x000D0x000A0x000D0x000ANote how documentation will include both -ApplicationSpecificCode- and -StandardAgoRapideCode- (as long as parameter assemblies contain the relevant assemblies).0x000D0x000AHint: Limit parameter 'assemblies' to only those assemblies containing your -ApplicationSpecificCode- in order to have documentation of only your application, without the AgoRapide library documentation 'coming in the way'.0x000D0x000A0x000D0x000ANote: If you want to publish the resulting data to -PropertyStream- you should prefix the data with -doc-.0x000D0x000A0x000D0x000AThe parameter specialPrefixes contains prefixes for which links are also desired for potential links without the prefix.0x000D0x000ASee -ARCQuery-.-QUtil- for example of use.0x000D0x000A0x000D0x000A
CreateAndInsert/__TOCDet/Attribute/MethodName = CreateAndInsert
CreateAndInsert/__TOCDet/Attribute/MethodSignature = ARCDoc.Documentator CreateAndInsert(ARCCore.IP, System.Collections.Generic.IEnumerable0x006010x005BSystem.Reflection.Assembly0x005D, System.Collections.Generic.List0x006010x005BSystem.String0x005D, Boolean)
CreateHTOCInheritance/__TOCDet/Assembly = ARCDoc
CreateHTOCInheritance/__TOCDet/Description = Creates a table of contents structured by inheritance (classes and interfaces only, not members).0x000D0x000A.0x000D0x000ASee also -CreateHTOCStandard- and -CreateHTOCNamespace-.
CreateHTOCInheritance/__TOCDet/DocFragType = ClassMember
CreateHTOCInheritance/__TOCDet/IsInherited = False
CreateHTOCInheritance/__TOCDet/IsInheritedDoc = False
CreateHTOCInheritance/__TOCDet/Lines = 3
CreateHTOCInheritance/__TOCDet/Name = CreateHTOCInheritance
CreateHTOCInheritance/__TOCDet/Namespace = ARCDoc
CreateHTOCInheritance/__TOCDet/Type = Documentator
CreateHTOCInheritance/__TOCDet/Attribute/DeclaringType = Documentator
CreateHTOCInheritance/__TOCDet/Attribute/Description = Creates a table of contents structured by inheritance (classes and interfaces only, not members).0x000D0x000A.0x000D0x000ASee also -CreateHTOCStandard- and -CreateHTOCNamespace-.
CreateHTOCInheritance/__TOCDet/Attribute/MethodName = CreateHTOCInheritance
CreateHTOCInheritance/__TOCDet/Attribute/MethodSignature = ARCDoc.HTOC CreateHTOCInheritance(ARCDoc.DocFragCollection)
CreateHTOCNamespace/__TOCDet/Assembly = ARCDoc
CreateHTOCNamespace/__TOCDet/Description = Creates a table of contents structured by namespace0x000D0x000A.0x000D0x000ASee also -CreateHTOCStandard- and -CreateHTOCInheritance-.
CreateHTOCNamespace/__TOCDet/DocFragType = ClassMember
CreateHTOCNamespace/__TOCDet/IsInherited = False
CreateHTOCNamespace/__TOCDet/IsInheritedDoc = False
CreateHTOCNamespace/__TOCDet/Lines = 3
CreateHTOCNamespace/__TOCDet/Name = CreateHTOCNamespace
CreateHTOCNamespace/__TOCDet/Namespace = ARCDoc
CreateHTOCNamespace/__TOCDet/Type = Documentator
CreateHTOCNamespace/__TOCDet/Attribute/DeclaringType = Documentator
CreateHTOCNamespace/__TOCDet/Attribute/Description = Creates a table of contents structured by namespace0x000D0x000A.0x000D0x000ASee also -CreateHTOCStandard- and -CreateHTOCInheritance-.
CreateHTOCNamespace/__TOCDet/Attribute/MethodName = CreateHTOCNamespace
CreateHTOCNamespace/__TOCDet/Attribute/MethodSignature = ARCDoc.HTOC CreateHTOCNamespace(ARCDoc.DocFragCollection)
CreateHTOCStandard/__TOCDet/Assembly = ARCDoc
CreateHTOCStandard/__TOCDet/Description = Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.0x000D0x000A0x000D0x000ASee also -CreateHTOCNamespace- and -CreateHTOCInheritance-.
CreateHTOCStandard/__TOCDet/DocFragType = ClassMember
CreateHTOCStandard/__TOCDet/IsInherited = False
CreateHTOCStandard/__TOCDet/IsInheritedDoc = False
CreateHTOCStandard/__TOCDet/Lines = 3
CreateHTOCStandard/__TOCDet/Name = CreateHTOCStandard
CreateHTOCStandard/__TOCDet/Namespace = ARCDoc
CreateHTOCStandard/__TOCDet/Type = Documentator
CreateHTOCStandard/__TOCDet/Attribute/DeclaringType = Documentator
CreateHTOCStandard/__TOCDet/Attribute/Description = Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.0x000D0x000A0x000D0x000ASee also -CreateHTOCNamespace- and -CreateHTOCInheritance-.
CreateHTOCStandard/__TOCDet/Attribute/MethodName = CreateHTOCStandard
CreateHTOCStandard/__TOCDet/Attribute/MethodSignature = ARCDoc.HTOC CreateHTOCStandard(ARCDoc.DocFragCollection)
DocLinkResolutionLocation/__TOCDet/Assembly = ARCDoc
DocLinkResolutionLocation/__TOCDet/Description = Default position within the global storage context of doc link resolution pages.0x000D0x000A0x000D0x000AValue: 'doc/DocLinkResolution'.
DocLinkResolutionLocation/__TOCDet/DocFragType = ClassMember
DocLinkResolutionLocation/__TOCDet/IsInherited = False
DocLinkResolutionLocation/__TOCDet/IsInheritedDoc = False
DocLinkResolutionLocation/__TOCDet/Lines = 3
DocLinkResolutionLocation/__TOCDet/Name = DocLinkResolutionLocation
DocLinkResolutionLocation/__TOCDet/Namespace = ARCDoc
DocLinkResolutionLocation/__TOCDet/Type = Documentator
DocLinkResolutionLocation/__TOCDet/Attribute/DeclaringType = Documentator
DocLinkResolutionLocation/__TOCDet/Attribute/Description = Default position within the global storage context of doc link resolution pages.0x000D0x000A0x000D0x000AValue: 'doc/DocLinkResolution'.
DocLinkResolutionLocation/__TOCDet/Attribute/MethodName = DocLinkResolutionLocation
DocLinkResolutionLocation/__TOCDet/Attribute/MethodSignature = System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D DocLinkResolutionLocation
DocLinks/__TOCDet/Assembly = ARCDoc
DocLinks/__TOCDet/Description = Set by -CreateAndInsert-.
DocLinks/__TOCDet/DocFragType = ClassMember
DocLinks/__TOCDet/IsInherited = False
DocLinks/__TOCDet/IsInheritedDoc = False
DocLinks/__TOCDet/Lines = 1
DocLinks/__TOCDet/Name = DocLinks
DocLinks/__TOCDet/Namespace = ARCDoc
DocLinks/__TOCDet/Type = Documentator
DocLinks/__TOCDet/Attribute/DeclaringType = Documentator
DocLinks/__TOCDet/Attribute/Description = Set by -CreateAndInsert-.
DocLinks/__TOCDet/Attribute/MethodName = DocLinks
DocLinks/__TOCDet/Attribute/MethodSignature = ARCDoc.DocLinkCollection DocLinks
ToHTMLSimpleSingle/__TOCDet/Assembly = ARCDoc
ToHTMLSimpleSingle/__TOCDet/Description = Alternative ('override') to -ToHTMLSimpleSingle-.0x000D0x000A0x000D0x000AContains hand coded HTML of documentation overview.0x000D0x000A0x000D0x000ANOTE: The mere existence of this method is not sufficient in order to avoid -ToHTMLSimpleSingle- being called.0x000D0x000A(extension method will be chosen anyway if instance is of type -IP-.0x000D0x000ASee ToHTMLSimpleSingle- for more details about this issue.0x000D0x000A
ToHTMLSimpleSingle/__TOCDet/DocFragType = ClassMember
ToHTMLSimpleSingle/__TOCDet/IsInherited = False
ToHTMLSimpleSingle/__TOCDet/IsInheritedDoc = False
ToHTMLSimpleSingle/__TOCDet/Lines = 8
ToHTMLSimpleSingle/__TOCDet/Name = ToHTMLSimpleSingle
ToHTMLSimpleSingle/__TOCDet/Namespace = ARCDoc
ToHTMLSimpleSingle/__TOCDet/Type = Documentator
ToHTMLSimpleSingle/__TOCDet/Attribute/DeclaringType = Documentator
ToHTMLSimpleSingle/__TOCDet/Attribute/Description = Alternative ('override') to -ToHTMLSimpleSingle-.0x000D0x000A0x000D0x000AContains hand coded HTML of documentation overview.0x000D0x000A0x000D0x000ANOTE: The mere existence of this method is not sufficient in order to avoid -ToHTMLSimpleSingle- being called.0x000D0x000A(extension method will be chosen anyway if instance is of type -IP-.0x000D0x000ASee ToHTMLSimpleSingle- for more details about this issue.0x000D0x000A
ToHTMLSimpleSingle/__TOCDet/Attribute/MethodName = ToHTMLSimpleSingle
ToHTMLSimpleSingle/__TOCDet/Attribute/MethodSignature = System.String ToHTMLSimpleSingle(Boolean, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D)
ToString/__TOCDet/Assembly = ARCDoc
ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
ToString/__TOCDet/DocFragType = ClassMember
ToString/__TOCDet/IsInherited = True
ToString/__TOCDet/IsInheritedDoc = True
ToString/__TOCDet/Name = ToString
ToString/__TOCDet/Namespace = ARCDoc
ToString/__TOCDet/Type = Documentator
ToString/__TOCDet/Attribute/DeclaringType = PRich
ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
ToString/__TOCDet/Attribute/MethodName = ToString
ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()
TryGetP/__TOCDet/Assembly = ARCDoc
TryGetP/__TOCDet/Description = Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
TryGetP/__TOCDet/DocFragType = ClassMember
TryGetP/__TOCDet/IsInherited = True
TryGetP/__TOCDet/IsInheritedDoc = True
TryGetP/__TOCDet/Name = TryGetP
TryGetP/__TOCDet/Namespace = ARCDoc
TryGetP/__TOCDet/Type = Documentator
TryGetP/__TOCDet/Attribute/DeclaringType = PRich
TryGetP/__TOCDet/Attribute/Description = Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
TryGetP/__TOCDet/Attribute/MethodName = TryGetP
TryGetP/__TOCDet/Attribute/MethodSignature = Boolean TryGetP0x005BT0x005D(ARCCore.IK, T ByRef, System.String ByRef)
TryGetV/__TOCDet/Assembly = ARCDoc
TryGetV/__TOCDet/Description = Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).0x000D0x000A0x000D0x000ASee -Value- for information about when this method IS relevant (when storing metadata about a property).
TryGetV/__TOCDet/DocFragType = ClassMember
TryGetV/__TOCDet/IsInherited = True
TryGetV/__TOCDet/IsInheritedDoc = True
TryGetV/__TOCDet/Name = TryGetV
TryGetV/__TOCDet/Namespace = ARCDoc
TryGetV/__TOCDet/Type = Documentator
TryGetV/__TOCDet/Attribute/DeclaringType = PRich
TryGetV/__TOCDet/Attribute/Description = Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).0x000D0x000A0x000D0x000ASee -Value- for information about when this method IS relevant (when storing metadata about a property).
TryGetV/__TOCDet/Attribute/MethodName = TryGetV
TryGetV/__TOCDet/Attribute/MethodSignature = Boolean TryGetV0x005BTRequest0x005D(TRequest ByRef, System.String ByRef)

Edit single sub keys only: __TOCDet / CreateAndInsert / CreateHTOCInheritance / CreateHTOCNamespace / CreateHTOCStandard / DocLinkResolutionLocation / DocLinks / ToHTMLSimpleSingle / ToString / TryGetP / TryGetV

Generated 2026-02-24 09:53:29.761 UTC