[ROOT]  doc  DocFrag  SELECT Assembly, DocFragType, Description.FirstLine()   <  SKIP 417  >   <  TAKE 240  >   

240 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.StreamProcessorP.TimestampResolutionARCCoreEnumMemberThe time interval between each timestamp update in the -PropertyStream-.
ARCCore.PP.CreatedARCCoreEnumMemberTimestamp when property was created in database.
ARCCore.ARConcepts.LinkInsertionInDocumentationARCCoreEnumMemberDocumentation with links is much easier to read.
ARCCore.PSPrefix.dtrARCCoreEnumMemberData, whole records.
ARCCore.StreamProcessorP.DoNotStoreLocallyARCCoreEnumMemberFor -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-.
ARCCore.PP.CidARCCoreEnumMemberCreator id (entity which created this property).
ARCCore.ARConcepts.TryPatternAndNullARCCoreEnumMemberAgoRapide uses non-nullable reference types as default throughout the system
ARCCore.PSPrefix.RSARCCoreEnumMemberRS = Registration Stream (see -RegStream-).
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocallyARCCoreEnumMemberMeans 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCCore.PP.ValueARCCoreEnumMemberThe actual value.
ARCCore.AREnumTypeARCCoreEnumCategories different types of enum used in AgoRapide. The most important one is -PropertyKeyEnum-.
ARCCore.PSPrefix.ESARCCoreEnumMemberES = Event Stream (see -EventStream-).
ARCCore.StreamProcessorP.CacheDiskWritesARCCoreEnumMemberIf TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCCore.PP.ValidARCCoreEnumMemberTimestamp when property was last known to be (still) valid
ARCCore.AREnumType.PropertyKeyEnumARCCoreEnumMemberDesignates enums that describe relevant values for an 'entity' object like 'Customer'.
ARCCore.PSPrefix.cmdARCCoreEnumMemberCommand.
ARCCore.StreamProcessorP.CopyFileStructureFromCoreARCCoreEnumMemberIf TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCCore.PP.VidARCCoreEnumMemberValidator id, that is entity which set -Valid- for this property.
ARCCore.AREnumType.OrdinaryEnumARCCoreEnumMemberDesignates "Ordinary" enums used for indicating range of valid values for a given key
ARCCore.PSPrefix.appARCCoreEnumMemberApplication state, like app/
ARCCore.StreamProcessorP.CountIncomingConnectionsARCCoreEnumMember 
ARCCore.PP.InvalidARCCoreEnumMemberTimestamp when property was invalidated / 'deleted'.
ARCCore.AREnumType.DocumentationOnlyEnumARCCoreEnumMemberDesignates enums that provide a central repository of explanation of terms that are not present in the C# code.
ARCCore.PSPrefix.docARCCoreEnumMemberDocumentation.
ARCCore.StreamProcessorP.CountOutgoingConnectionsARCCoreEnumMember 
ARCCore.PP.IidARCCoreEnumMemberInvalidator id, that is entity which set -Invalid- for this property (or removed / 'undid' the invalidation by setting the value to '0001-01-01').
ARCCore.ARNodeTypeARCCoreEnumDescribes what function a node in an AgoRapide system serves. A given node may constitute of only -StandardAgoRapideCode- or a combination of -StandardAgoRapideCode- and -ApplicationSpecificCode-.
ARCCore.PSPrefix.tARCCoreEnumMemberTranslations.
ARCCore.StreamProcessorP.CountOutsideLocalReceiverARCCoreEnumMemberCount of calls to -OutsideLocalReceiver-.
ARCCore.PP.ExceptionTextARCCoreEnumMemberGeneral property for logging of exceptions, usually set through -HandleException-.
ARCCore.ARNodeType.CoreDBARCCoreEnumMemberA node containing the core or central database.
ARCCore.PKHTMLAttributePARCCoreEnumDescribes class -PKRelAttribute-.
ARCCore.DataTransferDirectionARCCoreEnumDirection for transfer of data.
ARCCore.StreamProcessorP.CountReceiveLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- with -HasLocalOrigin-.
ARCCore.PKHTMLAttributeP.EncoderARCCoreEnumMemberThe class doing the HTML-encoding.
ARCCore.PConcurrentPARCCoreEnumDescribes class -PConcurrent-.
ARCCore.DataTransferDirection.SendARCCoreEnumMemberLike -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-.
ARCCore.StreamProcessorP.CountReceiveNonLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCCore.PKLogAttributePARCCoreEnumDescribes class -PKLogAttribute.
ARCCore.PConcurrentP.HeartbeatARCCoreEnumMember 
ARCCore.DataTransferDirection.ReceiveARCCoreEnumMemberLike -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCCore.StorageFilePARCCoreEnumDescribes class -StorageFile-.
ARCCore.PKLogAttributeP.DoNotLogAtAllARCCoreEnumMemberOriginates from -DoNotLogAtAll-.
ARCCore.ActualConnectionPARCCoreEnumDescribes class -ActualConnection-.
ARCCore.TPropertyKeyEnumARCCoreEnumPlaceholder for any enum type suitable as generic type parameter for -PExact-.
ARCCore.StorageFileP.FilenameARCCoreEnumMember 
ARCCore.PKLogAttributeP.CountIntervalARCCoreEnumMemberFor a value of n, log only every n'th time the property is changed.
ARCCore.ActualConnectionP.IdARCCoreEnumMemberWhen connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection.
Assembly ARCDoc AssemblyA library supporting documentation and demonstrating usage of AgoRapide.
ARCCore.StorageFileP.HashARCCoreEnumMemberHash of storage file. Not implemented as of Apr 2020. It is envisaged to store hash-value as last line in storage file. In this case the hash must be the hash of the file excluding the last line
ARCCore.PKLogAttributeP.TimeIntervalARCCoreEnumMemberSpecifies a certain time interval for which the property's value shall be sent over the -PropertyStream-.
ARCCore.ActualConnectionP.ConnectionInstructionARCCoreEnumMemberOnly relevant when we are an -Outgoing-.
ARCDoc.AppleARCDocClassThe most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCCore.ConnectionDirectionARCCoreEnumThe concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCCore.PKRelAttributePARCCoreEnumDescribes class -PKRelAttribute-.
ARCCore.ActualConnectionP.ConnectionDirectionARCCoreEnumMember 
ARCDoc.Apple.AddNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.ConnectionDirection.IncomingARCCoreEnumMemberConnectionInstruction will not be set for these.
ARCCore.PKRelAttributeP.ForeignEntityARCCoreEnumMemberThe type of foreign entity that this property points to.
ARCCore.ActualConnectionP.CountReceiveMessageARCCoreEnumMember 
ARCDoc.Apple.GetNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.ConnectionDirection.OutgoingARCCoreEnumMemberThere would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-:
ARCCore.PKRelAttributeP.OppositeTermARCCoreEnumMemberExample: For 'Employee', the key 'SupervisorId' where the supervisor is another 'Employee', will have another meaning "as seen from" the Supervisor, namely "Subordinates" or similar.
ARCCore.ActualConnectionP.CountSendMessageARCCoreEnumMember 
ARCDoc.DocFrag.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Apple.TryGetNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.ActualConnectionP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.ConnectionInstructionP.ShardingARCCoreEnumMember 
ARCDoc.DocFrag.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Apple.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClientARCCoreEnumMemberOriginates from -Subscription-.
ARCCore.MultipleConnectionUsageARCCoreEnumEnables fault-tolerance by describing use of multiple connections
ARCDoc.DocFrag.TryGetVARCDocClassMemberNote 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).
ARCDoc.Apple.TryGetVARCDocClassMemberNote 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).
ARCCore.ActualConnectionP.ClosingReasonARCCoreEnumMemberReason why this connection was closed
ARCCore.MultipleConnectionUsage.AdminARCCoreEnumMemberConnection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make.
ARCDoc.DocFrag.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Apple.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ActualConnectionP.IsErrorConditionARCCoreEnumMemberSome kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound.
ARCCore.MultipleConnectionUsage.RoundRobinARCCoreEnumMemberThis connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCDoc.DocFragCollectionARCDocClassContains a collection of -DocFrag- objects.
ARCDoc.Apple.NameARCDocClassMemberConvenience method, not obligatory.
ARCCore.ActualConnectionP.ErrorConditionDataARCCoreEnumMemberDetailed explanation about -IsErrorCondition-
ARCCore.MultipleConnectionUsage.SimultaneousARCCoreEnumMemberThis connection to be used simultaneously with other connections with -Simultaneous-
ARCDoc.DocFragCollection.CreateARCDocClassMemberCreates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCDoc.BananaARCDocClassImplements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCCore.ActualConnectionP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed and reinitialized.
ARCCore.StreamProcessorPARCCoreEnumDescribes class -StreamProcessor-.
ARCDoc.DocFragCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Banana.NameARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCCore.ActualConnectionP.MonkeyWrenchARCCoreEnumMember 
ARCCore.StreamProcessorP.LocalStorageFolderARCCoreEnumMemberThe local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCDoc.DocFragCollection.TryGetVARCDocClassMemberNote 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).
ARCDoc.Banana.ColourARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCCore.ActualConnectionP.PartnerIPAddressARCCoreEnumMemberTODO: Use more strongly typing for this.
ARCCore.StreamProcessorP.IndividualStorageFileSizeARCCoreEnumMemberMax size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCCore.ConnectionInstructionPARCCoreEnumDescribes class -ConnectionInstruction-.
ARCCore.StreamProcessorP.CurrentlyInitializingARCCoreEnumMemberSet to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCCore.ConnectionInstructionP.ClientIdARCCoreEnumMemberThe AgoRapide node-id for which this connection is relevant. Used for distributing over the -PropertyStream- information to the clients about which possible nodes they can connect to.
ARCCore.StreamProcessorP.ClientUpdatePositionPathARCCoreEnumMemberComplete path to file containing -ClientUpdatePosition-.
ARCCore.ConnectionInstructionP.ServerHostNameARCCoreEnumMemberThe host (DNS or IP-address) for which to connect.
ARCCore.StreamProcessorP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.ConnectionInstructionP.ServerPortNoARCCoreEnumMemberThe port number for which to connect.
ARCCore.StreamProcessorP.IncomingConnectionsPortNoARCCoreEnumMemberIf not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCCore.ConnectionInstructionP.ConnectionIdARCCoreEnumMemberUsually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-.
ARCCore.StreamProcessorP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCCore.ConnectionInstructionP.DataTransferDirectionARCCoreEnumMember 
ARCCore.StreamProcessorP.WriteToConsoleARCCoreEnumMemberIf true then incoming data (from other nodes will be written to console.
ARCCore.ConnectionInstructionP.SubscriptionARCCoreEnumMemberThe actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server.
ARCCore.StreamProcessorP.TimestampARCCoreEnumMemberThe timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCCore.ConnectionInstructionP.MultipleConnectionUsageARCCoreEnumMember 
ARCCore.StreamProcessorP.TimestampIsOldARCCoreEnumMemberA warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCDoc.Demonstrator.DemonstrateLogConsoleARCDocClassMemberDemonstrates a quite simple log console.
ARCDoc.DocLink.LinkWordHTMLWithHyphensARCDocClassMember-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClientARCDocClassMemberDemonstrates use of -StreamProcessor- as a general client.
ARCDoc.DocLink.LinkWordHTMLBeforeLtARCDocClassMemberIf -LinkWordHTML contains '<' (really '&lt;') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'.
ARCDoc.OrangeARCDocClassInherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphensARCDocClassMember-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.Orange.SetPVDirectARCDocClassMemberHigh performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCDoc.DocLink.AHrefEndPartARCDocClassMember'Filename.Encoded + "> + LinkWordHTML + </a>'
ARCDoc.Orange.GetPVDirectARCDocClassMemberHigh performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCDoc.DocLinkCollectionARCDocClassContains a collection of -DocLink- objects.
ARCDoc.Orange.TryGetPVDirectARCDocClassMemberHigh performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCDoc.DocLinkCollection.CreateARCDocClassMemberNotes all locations and their positions in the hierarchical directory structure.
ARCDoc.Orange.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkCollection.InsertLinks Overload1ARCDocClassMemberDoes -LinkInsertionInDocumentation- on the given HTML content.
ARCDoc.Orange.NameARCDocClassMemberSee -Name- for more information.
ARCDoc.DocLinkCollection.InsertLinks Overload2ARCDocClassMemberSee overload with 'contentLocation' as parameter for documentation.
ARCDoc.Orange.StorageARCDocClassMemberUses int-value of -__enum- minus 1 as index.
ARCDoc.DocLinkCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.SomeAppComponentARCDocClassDemonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCDoc.DocLinkCollection.TryGetVARCDocClassMemberNote 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).
ARCDoc.SomeAppComponent.MethodCARCDocClassMemberNote structured format in logging.
ARCDoc.DocLinkCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.SomeAppComponent.MethodDARCDocClassMemberSame as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCDoc.DocLinkResolutionARCDocClassContains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances).
ARCDoc.DocFragCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.SomeAppComponent.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkResolution.ToHTMLSimpleSingleARCDocClassMemberGives a friendly description about possible targets for LinkWord-.
ARCDoc.DocLinkARCDocClassDescribes to where a single HTML link points.
ARCDoc.DocFragARCDocClassDocFrag = Document fragment.
ARCDoc.DocLinkResolution.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLink.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocFrag.Create Overload1ARCDocClassMemberCreates a -DocFrag- object representing an assembly or a namespace.
ARCDoc.DocLinkResolution.TryGetVARCDocClassMemberNote 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).
ARCDoc.DocLink.TryGetVARCDocClassMemberNote 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).
ARCDoc.DocFrag.Create Overload2ARCDocClassMemberCreates a -DocFrag- object representing a class, class member, enum or enum member.
ARCDoc.DocLinkResolution.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLink.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkResolutionCollectionARCDocClassContains a collection of -DocLinkResolution- objects.
ARCDoc.PKDocAttributeARCDocClassDescribes documentation and presentation of a property.
ARCDoc.DocLink.LocationARCDocClassMemberCopy of -Location-.
ARCDoc.DocLinkResolutionCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.PKDocAttribute.InitializeARCDocClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCDoc.DocLink.FilenameARCDocClassMemberCopy of -LinkWordHTML-.
ARCDoc.DocLinkResolutionCollection.TryGetVARCDocClassMemberNote 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).
ARCDoc.PKDocAttribute.TryRemovePARCDocClassMemberShould probably never be used.
ARCDoc.DocLink.LinkWordHTMLARCDocClassMemberCopy of -LinkWordHTML-.
ARCDoc.DocLinkResolutionCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.PKDocAttribute.PriorityOrderARCDocClassMemberSee -PriorityOrder-.
ARCDoc.HLocation.ContentARCDocClassMemberThe Content object is not stored within the standard -IP--mechanism.
ARCDoc.DocumentatorARCDocClassGeneral class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCDoc.PKDocAttribute.IsDefaultARCDocClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCDoc.HLocationCollectionARCDocClassContains a collection of -HLocation- objects.
ARCDoc.Documentator.CreateAndInsertARCDocClassMemberCreates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
ARCDoc.UtilDocARCDocClassUtility methods for -ARCDoc-.
ARCDoc.HLocationCollection.CreateARCDocClassMemberTransforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects.
ARCDoc.Documentator.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.UtilDoc.GetCurrentLevelInHierarchyAsHTMLARCDocClassMemberReturns an HTML presentation of the given link context, with links pointing backwards to each level in the hierarchy.
ARCDoc.HLocationCollection.WriteAllContentHTMLToDiskARCDocClassMemberWrites all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-.
ARCDoc.Documentator.CreateHTOCStandardARCDocClassMemberCreates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.
ARCDoc.UtilDoc.GenerateHTMLPageARCDocClassMemberWraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS.
ARCDoc.HLocationCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Documentator.CreateHTOCNamespaceARCDocClassMemberCreates a table of contents structured by namespace
ARCDoc.UtilDoc.GlobalHeaderHTMLARCDocClassMemberGlobal header to be inserted at the top of every HTML page created by -GenerateHTMLPage-.
ARCDoc.HLocationCollection.TryGetVARCDocClassMemberNote 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).
ARCDoc.Documentator.CreateHTOCInheritanceARCDocClassMemberCreates a table of contents structured by inheritance (classes and interfaces only, not members).
ARCDoc.HTOC+ParentChainARCDocClassUsed by -FilterNode- in order to keep track of node's parents.
ARCDoc.HLocationCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Documentator.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.ApplePARCDocEnumDescribes class -Apple-.
ARCDoc.HTOCARCDocClassHTOC = Hierarchical table of contents.
ARCDoc.Documentator.TryGetVARCDocClassMemberNote 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).
ARCDoc.AppleP.NameARCDocEnumMemberThe name of the apple
ARCDoc.HTOC.CreateARCDocClassMemberStructures content hierarchically according to the criteria for each level.
ARCDoc.Documentator.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.AppleP.ColourARCDocEnumMember 
ARCDoc.HTOC.ToHTMLSimpleSingle Overload2ARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Documentator.DocLinksARCDocClassMemberSet by -CreateAndInsert-.
ARCDoc.BananaPARCDocEnumDescribes class -Banana-.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload1ARCDocClassMemberUse this method in any class where a table-of-contents type of view is desireable
ARCDoc.Documentator.DocLinkResolutionLocationARCDocClassMemberDefault position within the global storage context of doc link resolution pages.
ARCDoc.BananaP.NameARCDocEnumMemberThe name of the banana
ARCDoc.HTOC.CreateInitialContentARCDocClassMemberHelper method for creation of a -FilterBranch-.
ARCDoc.DummyEnumARCDocClassTODO: Document better what this is for (and change name)
ARCDoc.BananaP.ColourARCDocEnumMember 
ARCDoc.HTOC.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.OrangePARCDocEnumDescribes class -Orange-.
ARCDoc.DocFragP.AttributeARCDocEnumMemberThe -BaseAttribute- or -PK- from which this -DocFrag- originates.
ARCDoc.HTOC.TryGetVARCDocClassMemberNote 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).
ARCDoc.OrangeP.NameARCDocEnumMemberThe name of the orange
ARCDoc.DocFragTypeARCDocEnumType of documentation fragment, like -Assembly-, -Class- or -ClassMember-.
ARCDoc.HTOC.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.OrangeP.ColourARCDocEnumMember 
ARCDoc.DocFragType.AssemblyARCDocEnumMember 
ARCDoc.HTOC.HTOCContentThisLevelKeyARCDocClassMemberThe key used for storing the actual content at this level.
ARCDoc.SomeAppComponentPARCDocEnumDescribes class -SomeAppComponent-.
ARCDoc.DocFragType.NamespaceARCDocEnumMember 
ARCDoc.DummyEnumPARCDocEnumTODO: Document better what this is for (and change name)
ARCDoc.SomeAppComponentP.SomeCountValueARCDocEnumMember 
ARCDoc.DocFragType.ClassARCDocEnumMemberDoes also include interfaces.
ARCDoc.DummyEnumP._MemberInheritedARCDocEnumMemberContains not only members which are inherited in the object-oriented sense, but also overrides for which the only documentation was found in base class
ARCDoc.SomeAppComponentP.SomeCountValueNotToBeLoggedARCDocEnumMember 
ARCDoc.DocFragType.ClassMemberARCDocEnumMember 
ARCDoc.HLocationPARCDocEnumDescribes class -HLocation-.
ARCDoc.DocFragPARCDocEnumDescribes class -DocFrag-.
ARCDoc.DocFragType.EnumARCDocEnumMember 
ARCDoc.HLocationP.LocationARCDocEnumMemberFolder names / hierarchical levels.
ARCDoc.DocFragP.DocFragTypeARCDocEnumMember 
ARCDoc.DocFragType.EnumMemberARCDocEnumMember 
ARCDoc.HLocationP.FilenameARCDocEnumMemberEither the last hierarhical key for the content's location, or Index.html if no location.
ARCDoc.DocFragP.AssemblyARCDocEnumMemberName of the assembly in which this fragment resides.
ARCDoc.DocLinkPARCDocEnumDescribes class -DocLink-.
ARCDoc.HLocationP.ContentTypeARCDocEnumMemberThe type of the content object. The actual content object is stored as -Content-.
ARCDoc.DocFragP.NamespaceARCDocEnumMemberNamespace in which this fragment resides.
ARCDoc.DocLinkP.LocationARCDocEnumMemberThe location that this link points to.
ARCDoc.PKDocAttributePARCDocEnumDescribes class -PKDocAttribute-.
ARCDoc.DocFragP.ParentNamespaceARCDocEnumMemberParent namespace of namespace in which this fragment resides.
ARCDoc.DocLinkP.FilenameARCDocEnumMember 
ARCDoc.PKDocAttributeP.PriorityOrderARCDocEnumMemberUsed by -DescribeValue-.
ARCDoc.DocFragP.TypeARCDocEnumMemberType of class or enum which this fragment describes (also relevant for class or enum member).
ARCDoc.DocLinkP.LinkWordHTMLARCDocEnumMemberActual link as it is expected to occur in text, like '-MyCustomerClass&lt;T&gt;-'.
ARCDoc.PriorityOrderARCDocEnumUsed for general sorting / prioritizing when showing properties for an entity.
ARCDoc.DocFragP.NameARCDocEnumMemberAs simple a name as practical usable. Often not unique within a greater context.
ARCDoc.DocLinkResolutionPARCDocEnumDescribes class -DocLinkResolution-
ARCDoc.PriorityOrder.NotImportantARCDocEnumMember 
ARCDoc.DocFragP.IsInheritedARCDocEnumMemberRelevant for class members. TRUE if method is inherited from a base type.
ARCDoc.DocLinkResolutionP.LinkWordARCDocEnumMember 
ARCDoc.PriorityOrder.ImportantARCDocEnumMember 
ARCDoc.DocFragP.IsInheritedDocARCDocEnumMemberRelevant for class members (methods).

Generated 2026-05-18 06:06:09.445 UTC