/ doc / DocFrag / ARCDoc.Documentator.CreateAndInsert

ARCDoc.Documentator.CreateAndInsert

Edit keys at this level only

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

Assembly = ARCDoc
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
DocFragType = ClassMember
IsInherited = False
IsInheritedDoc = False
Lines = 19
Name = CreateAndInsert
Namespace = ARCDoc
Type = Documentator
Attribute/DeclaringType = Documentator
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
Attribute/MethodName = CreateAndInsert
Attribute/MethodSignature = ARCDoc.Documentator CreateAndInsert(ARCCore.IP, System.Collections.Generic.IEnumerable0x006010x005BSystem.Reflection.Assembly0x005D, System.Collections.Generic.List0x006010x005BSystem.String0x005D, Boolean)

Edit single sub keys only: Assembly / Attribute / Description / DocFragType / IsInherited / IsInheritedDoc / Lines / Name / Namespace / Type

Generated 2024-06-02 02:13:07.767 UTC