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

240 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.PSPrefix.docARCCoreEnumMemberDocumentation, like doc/.
ARCCore.ActualConnectionP.PartnerIPAddressARCCoreEnumMemberTODO: Use more strongly typing for this.
ARCCore.Subscription.IsAddARCCoreClassMemberCorresponds to whether value starts with a plus sign, '+' or not.
ARCCore.PKHTMLAttributePARCCoreEnumDescribes class -PKRelAttribute-.
ARCCore.ConnectionInstructionPARCCoreEnumDescribes class -ConnectionInstruction-.
ARCCore.Subscription.IsRemoveARCCoreClassMemberCorresponds to whether value starts with a minus sign, '+' or not.
ARCCore.PKHTMLAttributeP.EncoderARCCoreEnumMemberThe class doing the HTML-encoding.
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.UtilCoreARCCoreClassUtility methods for -ARCCore-.
ARCCore.PKLogAttributePARCCoreEnumDescribes class -PKLogAttribute.
ARCCore.ConnectionInstructionP.ServerHostNameARCCoreEnumMemberThe host (DNS or IP-address) for which to connect.
ARCCore.UtilCore.AssembliesARCCoreClassMemberAll relevant assemblies for application.
ARCAPI.DataStorage.DocLinksARCAPIClassMemberNote that may be null.
ARCCore.ConnectionInstructionP.ServerPortNoARCCoreEnumMemberThe port number for which to connect.
ARCCore.UtilCore.CultureARCCoreClassMemberThe general culture used for parsing.
ARCAPI.DataStorage.LockARCAPIClassMemberLocking object for thread-safe access from simultaneous API requests.
ARCCore.ConnectionInstructionP.ConnectionIdARCCoreEnumMemberUsually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-.
ARCCore.UtilCore.Culture_en_USARCCoreClassMemberUsed by -DoubleTryParse-.
ARCAPI.DataStorage.ExternalReceiverARCAPIClassMemberTypically used by -AddController-.
ARCCore.ConnectionInstructionP.DataTransferDirectionARCCoreEnumMember 
ARCCore.UtilCore.DefaultAgoRapideEncodingARCCoreClassMemberThe standard encoding used for text (UTF8).
ARCAPI.DataStorage.DoNotStoreInternallyARCAPIClassMemberTypically used by -AddController-.
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.UtilCore.ValidDateTimeFormatsARCCoreClassMember'yyyy-MM-dd HH:mm:ss.fff', 'yyyy-MM-dd HH:mm:ss', 'yyyy-MM-dd HH:mm', 'yyyy-MM-dd'
ARCAPI.BaseControllerPARCAPIEnumDescribes class -BaseController-.
ARCCore.ConnectionInstructionP.MultipleConnectionUsageARCCoreEnumMember 
ARCCore.UtilCore.ValidTimeSpanFormatsARCCoreClassMember'hh\:mm', 'hh\:mm\:ss', 'd\.hh\:mm\:ss', 'hh\:mm\:ss\.fff' // Milliseconds,'d\.hh\:mm\:ss\.fff'
ARCAPI.BaseControllerP.CountRequestARCAPIEnumMemberNumber of calls to -APIMethod- since application initialization
ARCCore.ConnectionInstructionP.ShardingARCCoreEnumMember 
ARCCore.RExARCCoreClassREx = 'TooDeepRecursiveDepthException'
ARCAPI.BaseControllerP.CountExceptionARCAPIEnumMemberNumber of exceptions at call to -APIMethod- since application initialization
ARCCore.MultipleConnectionUsageARCCoreEnumEnables fault-tolerance by describing use of multiple connections
ARCCore.REx.IncARCCoreClassMemberIncreases recursive count.
ARCAPI.BaseControllerP.LogLevelARCAPIEnumMember 
ARCCore.MultipleConnectionUsage.AdminARCCoreEnumMemberConnection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make.
ARCCore.ClassAttributeP.ClassTypeARCCoreEnumMemberThe actual type that we are a -ClassAttribute- for
ARCAPI.ResponseFormatARCAPIEnumThe response format, HTML or JSON, for an API request.
ARCCore.StreamProcessorP.CacheDiskWritesARCCoreEnumMemberIf TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCCore.ClassAttributeP.BaseTypesARCCoreEnumMemberThe inheritance hierarchy for this class, starting with base type (excluding 'object').r Not set if class does not inherit any class except 'object'
ARCAPI.ResponseFormat.JSONARCAPIEnumMember 
ARCCore.StreamProcessorP.CopyFileStructureFromCoreARCCoreEnumMemberIf TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCCore.ClassAttributeP.SubTypesARCCoreEnumMemberDirect and indirect sub types of this class.
ARCAPI.ResponseFormat.HTMLARCAPIEnumMember 
ARCCore.StreamProcessorP.CountIncomingConnectionsARCCoreEnumMember 
ARCCore.ClassAttributeP.InterfacesARCCoreEnumMemberAll interfaces that this class and its base classes implement
Assembly AgoMail Assembly 
ARCCore.StreamProcessorP.CountOutgoingConnectionsARCCoreEnumMember 
ARCCore.ClassAttributeP.InterfacesDirectlyImplementedARCCoreEnumMemberAll interfaces that this class directly implements.
AgoMail.CleanerAgoMailClass 
ARCCore.StreamProcessorP.CountOutsideLocalReceiverARCCoreEnumMemberCount of calls to -OutsideLocalReceiver-.
ARCCore.ClassAttributeP.CorrespondingEnumTypeARCCoreEnumMemberOnly relevant when implements -IP-.
AgoMail.Cleaner.CleanAgoMailClassMemberRemoves emails with often seen values for Subject, To or From.
ARCCore.StreamProcessorP.CountReceiveLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- with -HasLocalOrigin-.
ARCCore.ClassAttributeP.BoilerplateCodePropertiesAndStorageARCCoreEnumMemberOnly relevant when implements -IP- and when a -CorrespondingEnumType- is found.
AgoMail.EmailAgoMailClass 
ARCCore.StreamProcessorP.CountReceiveNonLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCCore.ClassMemberAttributePARCCoreEnumDescribes class -ClassMemberAttribute-.
AgoMail.Email.TryGetVAgoMailClassMemberNote 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.StorageFilePARCCoreEnumDescribes class -StorageFile-.
ARCCore.ARComponents.ARCDocARCCoreEnumMemberA library supporting documentation and demonstrating usage of AgoRapide.
AgoMail.Email.ToStringAgoMailClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StorageFileP.FilenameARCCoreEnumMember 
ARCCore.ARComponents.ARCQueryARCCoreEnumMemberARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
AgoMail.ProgramAgoMailClassApplication startup and initialization
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.ARComponents.ARCSyncARCCoreEnumMember(Not implemented as of March 2020)
AgoMail.Program.InitStreamProcessorAgoMailClassMemberInitializes stream processor.
ARCCore.ConnectionDirectionARCCoreEnumThe concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCCore.ARComponents.ARCSecARCCoreEnumMember(Not implemented as of March 2020)
AgoMail.RootAgoMailClassContains the user friendly welcome text (front page) for the application.
ARCCore.ConnectionDirection.IncomingARCCoreEnumMemberConnectionInstruction will not be set for these.
ARCCore.ARComponents.ARCAPIARCCoreEnumMemberA library providing an API on top of the -PropertyStream-.
AgoMail.Root.ToHTMLSimpleSingleAgoMailClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCCore.ConnectionDirection.OutgoingARCCoreEnumMemberThere would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-:
ARCCore.ARComponents.ARAAPIARCCoreEnumMemberThe corresponding template application for -ARCAPI- demonstrating its usage, providing an HTTP / HTTPS interface with the help of Microsoft.AspNetCore.Mvc.
AgoMail.Root.TryGetVAgoMailClassMemberNote 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.DataTransferDirectionARCCoreEnumDirection for transfer of data.
ARCCore.ARConceptsARCCoreEnumThe overarching concepts upon which AgoRapide is built.
AgoMail.Root.ToStringAgoMailClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.DataTransferDirection.SendARCCoreEnumMemberLike -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-.
ARCCore.ARConcepts.GettingStartedARCCoreEnumMemberAgoRapide 2020 is an open source library for building data-oriented backend applications using .NET Standard 2.1.
AgoMail.Controllers.ControllerFacadeAgoMailClassFacade for entry into the desired -BaseController-.
ARCCore.DataTransferDirection.ReceiveARCCoreEnumMemberLike -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCCore.ARConcepts.PropertyStreamARCCoreEnumMemberAgoRapide, the 'streams-of-water' database".
AgoMail.Controllers.ControllerFacade.CatchAll Overload2AgoMailClassMemberCatches all HTTP GET requests to this API.
ARCCore.TPropertyKeyEnumARCCoreEnumPlaceholder for any enum type suitable as generic type parameter for -PExact-.
ARCCore.ARConcepts.TaggingOfPropertyKeysARCCoreEnumMemberThe concept of specifying in a single place all relevant information about a given property (data field).
AgoMail.Controllers.ControllerFacade.CatchAll Overload1AgoMailClassMemberCatches all HTTP POST requests to this API.
Assembly ARCDoc AssemblyA library supporting documentation and demonstrating usage of AgoRapide.
ARCCore.ARConcepts.PropertyAccessARCCoreEnumMemberThe general mechanism for accessing properties of objects in AgoRapide.
AgoMail.EmailPAgoMailEnum 
ARCDoc.AppleARCDocClassThe most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCCore.ARConcepts.AvoidingRepetitionARCCoreEnumMemberAvoiding repetition, the overarching philosophy that inspired the rest of AgoRapide.
AgoMail.EmailP.DateAgoMailEnumMemberUTC-format
ARCDoc.Apple.AddNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.ARConcepts.AgoRapideHistoryARCCoreEnumMemberAgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language).
AgoMail.EmailP.FromAgoMailEnumMember 
ARCDoc.Apple.GetNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.ARConcepts.AdHocQueryARCCoreEnumMemberThe concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-.
AgoMail.EmailP.ToAgoMailEnumMember 
ARCDoc.Apple.TryGetNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.ARConcepts.StandardAgoRapideCodeARCCoreEnumMemberCode originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code)
AgoMail.EmailP.CCAgoMailEnumMember 
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.ARConcepts.ApplicationSpecificCodeARCCoreEnumMemberCode specific for an end-application.
AgoMail.EmailP.SubjectAgoMailEnumMember 
ARCDoc.Apple.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PKLogAttributeP.DoNotLogAtAllARCCoreEnumMemberOriginates from -DoNotLogAtAll-.
ARCDoc.Apple.NameARCDocClassMemberConvenience method, not obligatory.
ARCCore.PKLogAttributeP.CountIntervalARCCoreEnumMemberFor a value of n, log only every n'th time the property is changed.
ARCDoc.BananaARCDocClassImplements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCCore.PKLogAttributeP.TimeIntervalARCCoreEnumMemberSpecifies a certain time interval for which the property's value shall be sent over the -PropertyStream-.
ARCDoc.Banana.NameARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCCore.PKRelAttributePARCCoreEnumDescribes class -PKRelAttribute-.
ARCDoc.Banana.ColourARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCCore.PKRelAttributeP.ForeignEntityARCCoreEnumMemberThe type of foreign entity that this property points to.
ARCDoc.DemonstratorARCDocClassDemonstrates various concepts from -ARCCore-, especially -PropertyAccess-.
ARCCore.PKRelAttributeP.EnforceReferentialIntegrityARCCoreEnumMemberIf TRUE then referential integrity will be enforced by -TryStore-.
ARCDoc.Demonstrator.DemonstratePropertyAccessAppleARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Apple- class.
ARCCore.PKTypeAttributePARCCoreEnumDescribes class -PKTypeAttribute-.
ARCDoc.Demonstrator.DemonstratePropertyAccessOrangeARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Orange- class.
ARCCore.PKTypeAttributeP.TypeARCCoreEnumMemberThe type of this Property.
ARCDoc.Demonstrator.DemonstratePropertyAccessBananaARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Banana- class.
ARCCore.PKTypeAttributeP.DefaultValueARCCoreEnumMemberThe default value.
ARCDoc.Demonstrator.DemonstrateITypeDescriberARCDocClassMemberDemonstrates use of -ITypeDescriber- for describing single-property values.
ARCCore.PKTypeAttributeP.CardinalityARCCoreEnumMemberDescribes how multiple instances of a property is supposed to be handled.
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorageARCDocClassMemberDemonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage.
ARCCore.PKTypeAttributeP.IsObligatoryARCCoreEnumMemberTrue means value is obligatory.
ARCDoc.Demonstrator.DemonstratePropertyStreamARCDocClassMemberDemonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console.
ARCCore.PKTypeAttributeP.BoilerplateCodePropertiesARCCoreEnumMemberAutomatically generated boilerplate code that implements traditional setters and getters for this key.
ARCDoc.Demonstrator.DemonstrateBareBonesClientARCDocClassMemberDemonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET.
ARCCore.PPARCCoreEnumDescribes meta data for any class (property) implementing -IP-.
ARCDoc.Demonstrator.DemonstrateLogConsoleARCDocClassMemberDemonstrates a quite simple log console.
ARCCore.PP.CreatedARCCoreEnumMemberTimestamp when property was created in database.
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClientARCDocClassMemberDemonstrates use of -StreamProcessor- as a general client.
ARCCore.PP.CidARCCoreEnumMemberCreator id (entity which created this property).
ARCDoc.OrangeARCDocClassInherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCCore.PP.ValueARCCoreEnumMemberThe actual value.
ARCDoc.Orange.NameARCDocClassMemberSee -Name- for more information.
ARCCore.MultipleConnectionUsage.RoundRobinARCCoreEnumMemberThis connection to be used in a turn based system, together with other connections with -RoundRobin-.
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).
ARCCore.MultipleConnectionUsage.SimultaneousARCCoreEnumMemberThis connection to be used simultaneously with other connections with -Simultaneous-
ARCDoc.DocLink.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessorPARCCoreEnumDescribes class -StreamProcessor-.
ARCDoc.DocLink.LocationARCDocClassMemberCopy of -Location-.
ARCCore.StreamProcessorP.LocalStorageFolderARCCoreEnumMemberThe local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCDoc.DocLink.FilenameARCDocClassMemberCopy of -LinkWordHTML-.
ARCCore.StreamProcessorP.IndividualStorageFileSizeARCCoreEnumMemberMax size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCDoc.DocLink.LinkWordHTMLARCDocClassMemberCopy of -LinkWordHTML-.
ARCCore.StreamProcessorP.CurrentlyInitializingARCCoreEnumMemberSet to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCDoc.DocLink.LinkWordHTMLWithHyphensARCDocClassMember-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
ARCCore.StreamProcessorP.ClientUpdatePositionPathARCCoreEnumMemberComplete path to file containing -ClientUpdatePosition-.
ARCDoc.DocLink.LinkWordHTMLBeforeLtARCDocClassMemberIf -LinkWordHTML contains '<' (really '&lt;') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'.
ARCCore.StreamProcessorP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphensARCDocClassMember-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
ARCCore.StreamProcessorP.IncomingConnectionsPortNoARCCoreEnumMemberIf not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCDoc.DocLink.AHrefEndPartARCDocClassMember'Filename.Encoded + "> + LinkWordHTML + </a>'
ARCCore.StreamProcessorP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCDoc.DocLinkCollectionARCDocClassContains a collection of -DocLink- objects.
ARCCore.StreamProcessorP.WriteToConsoleARCCoreEnumMemberIf true then incoming data (from other nodes will be written to console.
ARCDoc.DocLinkCollection.CreateARCDocClassMemberNotes all locations and their positions in the hierarchical directory structure.
ARCCore.StreamProcessorP.TimestampARCCoreEnumMemberThe timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCDoc.DocLinkCollection.InsertLinksARCDocClassMemberDoes -LinkInsertionInDocumentation- on the given HTML content.
ARCCore.StreamProcessorP.TimestampIsOldARCCoreEnumMemberA warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
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).
ARCCore.StreamProcessorP.TimestampResolutionARCCoreEnumMemberThe time interval between each timestamp update in the -PropertyStream-.
ARCDoc.DocLinkCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessorP.DoNotStoreLocallyARCCoreEnumMemberFor -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-.
ARCDoc.DocLinkResolutionARCDocClassContains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances).
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocallyARCCoreEnumMemberMeans 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCDoc.DocLinkResolution.ToHTMLSimpleSingleARCDocClassMemberGives a friendly description about possible targets for LinkWord-.
ARCDoc.Orange.StorageARCDocClassMemberUses int-value of -__enum- minus 1 as index.
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.SomeAppComponentARCDocClassDemonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCDoc.DocLinkResolution.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.SomeAppComponent.MethodCARCDocClassMemberNote structured format in logging.
ARCDoc.DocLinkResolutionCollectionARCDocClassContains a collection of -DocLinkResolution- objects.
ARCDoc.SomeAppComponent.MethodDARCDocClassMemberSame as MethodC- but returns data ('Func<string>()' instead of 'Action()')
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.SomeAppComponent.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkResolutionCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFragARCDocClassDocFrag = Document fragment.
ARCDoc.DocumentatorARCDocClassGeneral class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCDoc.DocFrag.Create Overload1ARCDocClassMemberCreates a -DocFrag- object representing an assembly or a namespace.
ARCDoc.Documentator.CreateAndInsertARCDocClassMemberCreates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
ARCDoc.DocFrag.Create Overload2ARCDocClassMemberCreates a -DocFrag- object representing a class, class member, enum or enum member.
ARCDoc.Documentator.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.DocFrag.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Documentator.CreateHTOCStandardARCDocClassMemberCreates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.
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.Documentator.CreateHTOCNamespaceARCDocClassMemberCreates a table of contents structured by namespace
ARCDoc.DocFrag.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Documentator.CreateHTOCInheritanceARCDocClassMemberCreates a table of contents structured by inheritance (classes and interfaces only, not members).
ARCDoc.DocFragCollectionARCDocClassContains a collection of -DocFrag- objects.
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.DocFragCollection.CreateARCDocClassMemberCreates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCDoc.Documentator.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
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.Documentator.DocLinksARCDocClassMemberSet by -CreateAndInsert-.
ARCDoc.DocFragCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Documentator.DocLinkResolutionLocationARCDocClassMemberDefault position within the global storage context of doc link resolution pages.
ARCDoc.DocLinkARCDocClassDescribes to where a single HTML link points.
ARCDoc.DummyEnumARCDocClassTODO: Document better what this is for (and change name)
ARCDoc.DummyEnum.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.HLocationCollection.WriteAllContentHTMLToDiskARCDocClassMemberWrites all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-.
ARCDoc.DummyEnum.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
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.ExtensionsARCDocClassContains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML.
ARCDoc.HLocationCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Extensions.ToHTMLSimpleSingleRecursiveARCDocClassMemberCalls -ToHTMLSimpleSingle- recursively.
ARCDoc.HTOCARCDocClassHTOC = Hierarchical table of contents.
ARCDoc.Extensions.ToHTMLSimpleSingleARCDocClassMemberCreates a simple HTML representation of the given parameter.
ARCDoc.HTOC.CreateARCDocClassMemberStructures content hierarchically according to the criteria for each level.
ARCDoc.Extensions.ToHTMLSimpleSingleInternalARCDocClassMemberHack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload2ARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Extensions.ToHTMLSimpleAsTableRowARCDocClassMemberCreates a simple HTML representation of the given parameter as a single two column row (Key, Value) in a table.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload1ARCDocClassMemberUse this method in any class where a table-of-contents type of view is desireable
ARCDoc.Extensions.DescribeValueARCDocClassMemberDescribes the value contained withing an -IKIP- (-P-).
ARCDoc.HTOC.CreateInitialContentARCDocClassMemberHelper method for creation of a -FilterBranch-.
ARCDoc.Extensions.ValueToHTMLSimpleWithTooltipARCDocClassMemberCreates a simple HTML representation of the Value with description as a 'tooltip'.
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.Extensions.KeyToHTMLSimpleWithTooltipARCDocClassMemberCreates a simple HTML representation of the Key with description as a 'tooltip'.
ARCDoc.HTOC.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.HLocationARCDocClassSimple class describing the location of a single -IP- instance within some hierarhical context.
ARCDoc.HTOC.HTOCContentThisLevelKeyARCDocClassMemberThe key used for storing the actual content at this level.
ARCDoc.HLocation.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.PKDocAttributeARCDocClassDescribes documentation and presentation of a property.
ARCDoc.HLocation.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
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.HLocation.ContentARCDocClassMemberThe Content object is not stored within the standard -IP--mechanism.
ARCDoc.PKDocAttribute.TryRemovePARCDocClassMemberShould probably never be used.
ARCDoc.HLocationCollectionARCDocClassContains a collection of -HLocation- objects.
ARCDoc.PKDocAttribute.PriorityOrderARCDocClassMemberSee -PriorityOrder-.
ARCDoc.HLocationCollection.CreateARCDocClassMemberTransforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects.
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.DocFragPARCDocEnumDescribes class -DocFrag-.
ARCDoc.UtilDocARCDocClassUtility methods for -ARCDoc-.
ARCDoc.DocFragP.DocFragTypeARCDocEnumMember 
ARCDoc.UtilDoc.GetCurrentLevelInHierarchyAsHTMLARCDocClassMemberReturns an HTML presentation of the given link context, with links pointing backwards to each level in the hierarchy.
ARCDoc.DocFragP.AssemblyARCDocEnumMemberName of the assembly in which this fragment resides.

Generated 2025-11-07 04:35:02.584 UTC