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

124 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCDoc.DocLink.LinkWordHTMLWithHyphens	ARCDoc	ClassMember	-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
ARCCore.StreamProcessorP.CurrentlyInitializing	ARCCore	EnumMember	Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCCore.StreamProcessor+StorageFile.Length	ARCCore	ClassMember	Wrongly placed. Belongs to each individual revision file.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload2	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.DocLink.LinkWordHTMLBeforeLt	ARCDoc	ClassMember	If -LinkWordHTML contains '<' (really '<') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'.
ARCCore.StreamProcessorP.ClientUpdatePositionPath	ARCCore	EnumMember	Complete path to file containing -ClientUpdatePosition-.
ARCCore.StreamProcessor+StorageFile.Properties	ARCCore	ClassMember	Key = revision number of file (due to compression / -DataRetention-), like R00001, R00002 and so on.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload1	ARCDoc	ClassMember	Use this method in any class where a table-of-contents type of view is desireable
ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphens	ARCDoc	ClassMember	-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
ARCCore.StreamProcessorP.ClientUpdatePosition	ARCCore	EnumMember	Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.BaseAttributeP	ARCCore	Enum	Describes class -BaseAttribute-.
ARCDoc.HTOC.CreateInitialContent	ARCDoc	ClassMember	Helper method for creation of a -FilterBranch-.
ARCDoc.DocLink.AHrefEndPart	ARCDoc	ClassMember	'Filename.Encoded + "> + LinkWordHTML + </a>'
ARCCore.StreamProcessorP.IncomingConnectionsPortNo	ARCCore	EnumMember	If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCCore.BaseAttributeP.Description	ARCCore	EnumMember	The description for the attribute, like this description
ARCDoc.HTOC.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLinkCollection	ARCDoc	Class	Contains a collection of -DocLink- objects.
ARCCore.StreamProcessorP.UnderClosure	ARCCore	EnumMember	Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCCore.BaseAttributeP.LongDescription	ARCCore	EnumMember	The long (detailed) description for the attribute.
ARCDoc.HTOC.TryGetV	ARCDoc	ClassMember	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).
ARCDoc.DocLinkCollection.Create	ARCDoc	ClassMember	Notes all locations and their positions in the hierarchical directory structure.
ARCCore.StreamProcessorP.WriteToConsole	ARCCore	EnumMember	If true then incoming data (from other nodes will be written to console.
ARCCore.ClassAttributeP	ARCCore	Enum	Describes class -ClassAttribute-.
ARCDoc.HTOC.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkCollection.InsertLinks Overload1	ARCDoc	ClassMember	Does -LinkInsertionInDocumentation- on the given HTML content.
ARCCore.StreamProcessorP.Timestamp	ARCCore	EnumMember	The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCCore.ClassAttributeP.AssemblyName	ARCCore	EnumMember	The assembly in which this class resides.
ARCDoc.HTOC.HTOCContentThisLevelKey	ARCDoc	ClassMember	The key used for storing the actual content at this level.
ARCDoc.DocLinkCollection.InsertLinks Overload2	ARCDoc	ClassMember	See overload with 'contentLocation' as parameter for documentation.
ARCCore.StreamProcessorP.TimestampIsOld	ARCCore	EnumMember	A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCCore.ClassAttributeP.ClassNamespace	ARCCore	EnumMember	The namespace for -ClassType-.
ARCDoc.OrangeP	ARCDoc	Enum	Describes class -Orange-.
ARCDoc.Extensions.DescribeValue	ARCDoc	ClassMember	Describes the value contained withing an -IKIP- (-P-).
ARCDoc.Demonstrator.DemonstrateLogConsole	ARCDoc	ClassMember	Demonstrates a quite simple log console.
ARCCore.EnumAttributeP.CorrespondingClass	ARCCore	EnumMember	Only relevant when -PropertyKeyEnum-.
ARCDoc.OrangeP.Name	ARCDoc	EnumMember	The name of the orange
ARCDoc.Extensions.ValueToHTMLSimpleWithTooltip	ARCDoc	ClassMember	Creates a simple HTML representation of the Value with description as a 'tooltip'.
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient	ARCDoc	ClassMember	Demonstrates use of -StreamProcessor- as a general client.
ARCCore.EnumMemberAttributeP	ARCCore	Enum	Describes class -EnumMemberAttribute-.
ARCDoc.OrangeP.Colour	ARCDoc	EnumMember
ARCDoc.Extensions.KeyToHTMLSimpleWithTooltip	ARCDoc	ClassMember	Creates a simple HTML representation of the Key with description as a 'tooltip'.
ARCDoc.Orange	ARCDoc	Class	Inherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCCore.EnumMemberAttributeP.EnumType	ARCCore	EnumMember	The type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for
ARCDoc.SomeAppComponentP	ARCDoc	Enum	Describes class -SomeAppComponent-.
ARCDoc.Extensions.GetHelptextHTML	ARCDoc	ClassMember	Returns content of -Description- and -LongDescription-.
ARCDoc.Orange.SetPVDirect	ARCDoc	ClassMember	High performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCCore.EnumMemberAttributeP.EnumMember	ARCCore	EnumMember	The actual enum member / enum value (like 'Firstname' in CustomerP.FirstName) that we are an attribute for
ARCDoc.SomeAppComponentP.SomeCountValue	ARCDoc	EnumMember
ARCDoc.HLocation	ARCDoc	Class	Simple class describing the location of a single -IP- instance within some hierarhical context.
ARCDoc.Orange.GetPVDirect	ARCDoc	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.ARComponents	ARCCore	Enum	ARComponents = AgoRapide Components. Contains short descriptions of the different 'official' AgoRapide components.
ARCDoc.SomeAppComponentP.SomeCountValueNotToBeLogged	ARCDoc	EnumMember
ARCDoc.HLocation.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Orange.TryGetPVDirect	ARCDoc	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.ARComponents.ARCCore	ARCCore	EnumMember	A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCDoc.DocFragP	ARCDoc	Enum	Describes class -DocFrag-.
ARCDoc.HLocation.TryGetV	ARCDoc	ClassMember	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).
ARCDoc.Orange.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.ARComponents.ARADB	ARCCore	EnumMember	An application constituting the full functionality of a -CoreDB- (linking to -ARCCore-).
ARCDoc.DocFragP.DocFragType	ARCDoc	EnumMember
ARCDoc.HLocation.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Orange.Name	ARCDoc	ClassMember	See -Name- for more information.
ARCCore.ARComponents.ARAClient	ARCCore	EnumMember	A template application for a -Client- (linking to -ARCCore-).
ARCDoc.DocLinkP	ARCDoc	Enum	Describes class -DocLink-.
ARCDoc.HLocation.Content	ARCDoc	ClassMember	The Content object is not stored within the standard -IP--mechanism.
ARCDoc.Orange.Storage	ARCDoc	ClassMember	Uses int-value of -__enum- minus 1 as index.
ARCCore.ARConcepts.CoreDBSynchronization	ARCCore	EnumMember	The concept of how multiple -CoreDB- instances synchronizes their data.
ARCDoc.DocLinkP.Location	ARCDoc	EnumMember	The location that this link points to.
ARCDoc.HLocationCollection	ARCDoc	Class	Contains a collection of -HLocation- objects.
ARCDoc.SomeAppComponent	ARCDoc	Class	Demonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCCore.ARConcepts.SingleThreadedCode	ARCCore	EnumMember	Some practical choices have been made in AgoRapide which requires object access to be done in a single-threaded manner, or within a locking context (using for instance -ReaderWriterLockSlim-).
ARCDoc.DocLinkP.Filename	ARCDoc	EnumMember
ARCDoc.HLocationCollection.Create	ARCDoc	ClassMember	Transforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects.
ARCDoc.SomeAppComponent.MethodC	ARCDoc	ClassMember	Note structured format in logging.
ARCCore.ARConcepts.DataRetention	ARCCore	EnumMember	The concept of when to delete old data (if deemed necessary).
ARCDoc.DocLinkP.LinkWordHTML	ARCDoc	EnumMember	Actual link as it is expected to occur in text, like '-MyCustomerClass<T>-'.
ARCDoc.HLocationCollection.WriteAllContentHTMLToDisk	ARCDoc	ClassMember	Writes all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-.
ARCDoc.SomeAppComponent.MethodD	ARCDoc	ClassMember	Same as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCCore.ARConcepts.NoRealDeletion	ARCCore	EnumMember	AgoRapide has no real concept for deletion of data (apart from -DataRetention-, which is mostly relevant for 'old' data).
ARCDoc.DocLinkResolutionP	ARCDoc	Enum	Describes class -DocLinkResolution-
ARCDoc.HLocationCollection.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.SomeAppComponent.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.ARConcepts.ManyToManyRelations	ARCCore	EnumMember	-ARCQuery- supports many-to-many relations in a simple manner without introducing a third entity type (a third table).
ARCDoc.DocLinkResolutionP.LinkWord	ARCDoc	EnumMember
ARCDoc.HLocationCollection.TryGetV	ARCDoc	ClassMember	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).
ARCDoc.DocFrag	ARCDoc	Class	DocFrag = Document fragment.
ARCCore.ARConcepts.Documentation	ARCCore	EnumMember	Thanks to the tagging of enums and classes in AgoRapide (like this description), automatically generation of documentation is possible.
ARCDoc.DocLinkResolutionP.DocLinks	ARCDoc	EnumMember	The possible links for -LinkWord-
ARCDoc.HLocationCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFrag.Create Overload1	ARCDoc	ClassMember	Creates a -DocFrag- object representing an assembly or a namespace.
ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessages	ARCCore	EnumMember	The abstraction level in AgoRapide is very high.
ARCDoc.DocumentatorP	ARCDoc	Enum	Describes class -Documentator-.
ARCDoc.HTOC	ARCDoc	Class	HTOC = Hierarchical table of contents.
ARCDoc.DocFrag.Create Overload2	ARCDoc	ClassMember	Creates a -DocFrag- object representing a class, class member, enum or enum member.
ARCCore.ARConcepts.ExposingApplicationState	ARCCore	EnumMember	The traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool.
ARCDoc.DummyEnumP	ARCDoc	Enum	TODO: Document better what this is for (and change name)
ARCDoc.DocFragP.Assembly	ARCDoc	EnumMember	Name of the assembly in which this fragment resides.
ARCDoc.DocLinkResolutionCollection	ARCDoc	Class	Contains a collection of -DocLinkResolution- objects.
ARCDoc.Apple.TryGetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.DummyEnumP._MemberInherited	ARCDoc	EnumMember	Contains 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.DocFragP.Namespace	ARCDoc	EnumMember	Namespace in which this fragment resides.
ARCDoc.DocLinkResolutionCollection.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Apple.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.HLocationP	ARCDoc	Enum	Describes class -HLocation-.
ARCDoc.DocFragP.ParentNamespace	ARCDoc	EnumMember	Parent namespace of namespace in which this fragment resides.
ARCDoc.DocLinkResolutionCollection.TryGetV	ARCDoc	ClassMember	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).
ARCDoc.Apple.TryGetV	ARCDoc	ClassMember	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).
ARCDoc.HLocationP.Location	ARCDoc	EnumMember	Folder names / hierarchical levels.
ARCDoc.DocFragP.Type	ARCDoc	EnumMember	Type of class or enum which this fragment describes (also relevant for class or enum member).
ARCDoc.DocLinkResolutionCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Apple.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.HLocationP.Filename	ARCDoc	EnumMember	Either the last hierarhical key for the content's location, or Index.html if no location.
ARCDoc.DocFragP.Name	ARCDoc	EnumMember	As simple a name as practical usable. Often not unique within a greater context.
ARCDoc.Documentator	ARCDoc	Class	General class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCDoc.Apple.Name	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.HLocationP.ContentType	ARCDoc	EnumMember	The type of the content object. The actual content object is stored as -Content-.
ARCDoc.DocFragP.IsInherited	ARCDoc	EnumMember	Relevant for class members. TRUE if method is inherited from a base type.
ARCDoc.Documentator.CreateAndInsert	ARCDoc	ClassMember	Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
ARCDoc.Banana	ARCDoc	Class	Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCDoc.PKDocAttributeP	ARCDoc	Enum	Describes class -PKDocAttribute-.
ARCDoc.DocFragP.IsInheritedDoc	ARCDoc	EnumMember	Relevant for class members (methods).
ARCDoc.Documentator.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Banana.Name	ARCDoc	ClassMember	Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCDoc.PKDocAttributeP.PriorityOrder	ARCDoc	EnumMember	Used by -DescribeValue-.

Generated 2025-12-21 03:57:27.759 UTC