[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 542 > < TAKE 224 >
224 items
DocFragId | Assembly | DocFragType | Description.FirstLine() |
---|---|---|---|
ARCQuery.AggregationType.Sum | ARCQuery | EnumMember | |
ARCCore.ARConcepts.PropertyAccess | ARCCore | EnumMember | The general mechanism for accessing properties of objects in AgoRapide. |
ARCCore.PKTypeAttributeP | ARCCore | Enum | Describes class -PKTypeAttribute-. |
ARCQuery.RelationalOperator | ARCQuery | Enum | Relational / comparision operators. |
ARCCore.ARConcepts.AvoidingRepetition | ARCCore | EnumMember | Avoiding repetition, the overarching philosophy that inspired the rest of AgoRapide. |
ARCCore.PKTypeAttributeP.Type | ARCCore | EnumMember | The type of this Property. |
ARCQuery.RelationalOperator.EQ | ARCQuery | EnumMember | |
ARCCore.ARConcepts.AgoRapideHistory | ARCCore | EnumMember | AgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language). |
ARCCore.PKTypeAttributeP.DefaultValue | ARCCore | EnumMember | The default value. |
ARCQuery.RelationalOperator.CONTAINS | ARCQuery | EnumMember | |
ARCCore.ARConcepts.AdHocQuery | ARCCore | EnumMember | The concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-. |
ARCCore.ActualConnectionP.ConnectionInstruction | ARCCore | EnumMember | Only relevant when we are an -Outgoing-. |
ARCQuery.QueryProgressP.CreateHints | ARCQuery | EnumMember | Describes if hints are to be generated (as query progresses) for new queries. |
ARCCore.AREnumType.OrdinaryEnum | ARCCore | EnumMember | Designates "Ordinary" enums used for indicating range of valid values for a given key |
ARCCore.ActualConnectionP.ConnectionDirection | ARCCore | EnumMember | |
ARCQuery.QueryProgressP.UseCache | ARCQuery | EnumMember | Describes if cache is to be used or not. |
ARCCore.AREnumType.DocumentationOnlyEnum | ARCCore | EnumMember | Designates enums that provide a central repository of explanation of terms that are not present in the C# code. |
ARCCore.ActualConnectionP.CountReceiveMessage | ARCCore | EnumMember | |
ARCQuery.QueryProgressP.LinkAdjustment | ARCQuery | EnumMember | Experimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level). |
ARCCore.ARNodeType | ARCCore | Enum | Describes 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.ActualConnectionP.CountSendMessage | ARCCore | EnumMember | |
ARCQuery.QueryProgressP.Limit | ARCQuery | EnumMember | Limits the final HTML presentation of results (limits the number of elements being presented). Does not affect the query in itself. Used in order to avoid building huge HTML pages which will not be consumed anyway. |
ARCCore.ARNodeType.CoreDB | ARCCore | EnumMember | A node containing the core or central database. |
ARCCore.ActualConnectionP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
ARCQuery.QueryProgressP.TerminateReason | ARCQuery | EnumMember | The reason for a query being terminated. This property should contain a user friendly message about the problem and how to fix it. |
ARCCore.ARNodeType.ArmDB | ARCCore | EnumMember | A node with a 'client -Subscription-' towards -CoreDB- to a (usually) subset of the entire database (acting as a cache and filtering mechanism), or with a 'client -Subscription-' towards -CoreDB- to the whole database (acting as a cache mechanism only) |
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClient | ARCCore | EnumMember | Originates from -Subscription-. |
ARCQuery.QueryProgressP.AllLogEntriesForThisQuery | ARCQuery | EnumMember | |
ARCCore.ARNodeType.Client | ARCCore | EnumMember | An outer node / 'end' node with (usually) -ApplicationSpecificCode- but based on -ARADB-. |
ARCCore.ActualConnectionP.ClosingReason | ARCCore | EnumMember | Reason why this connection was closed |
ARCQuery.TranslationsP | ARCQuery | Enum | This enum has no values because the keys are the actual string to be translated. |
ARCCore.Cardinality | ARCCore | Enum | Describes how multiple instances of a property is supposed to be handled. |
ARCCore.ActualConnectionP.IsErrorCondition | ARCCore | EnumMember | Some kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound. |
ARCQuery.TranslationSingleP | ARCQuery | Enum | Describes class -TranslationSingle-. |
ARCCore.Cardinality.HistoryOnly | ARCCore | EnumMember | The default value. |
ARCCore.ActualConnectionP.ErrorConditionData | ARCCore | EnumMember | Detailed explanation about -IsErrorCondition- |
ARCQuery.TranslationSingleP.Text | ARCQuery | EnumMember | |
ARCCore.Cardinality.WholeCollection | ARCCore | EnumMember | Values are always set as a whole (there is no need or no meaning in setting or deleting individual items) |
ARCCore.ActualConnectionP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed and reinitialized. |
ARCQuery.TranslationSingleP.IsMissing | ARCQuery | EnumMember | Value TRUE indicates that the Text given is simply the original key, in other words, the translation for the key is actually missing. |
ARCCore.Cardinality.IndividualItems | ARCCore | EnumMember | Values are supposed to be set and 'deleted' individually. |
ARCCore.ActualConnectionP.MonkeyWrench | ARCCore | EnumMember | |
ARCQuery.EntityMethodKey+MethodType | ARCQuery | Enum | Explains type of method signature found (trough reflection) for corresponding entity class. |
ARCCore.PSPrefix | ARCCore | Enum | Describes some recommended prefixes to use in a -PropertyStreamLine-. |
ARCCore.ActualConnectionP.PartnerIPAddress | ARCCore | EnumMember | TODO: Use more strongly typing for this. |
ARCQuery.EntityMethodKey+MethodType.Simple | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)' |
ARCCore.PSPrefix.dt | ARCCore | EnumMember | Data, single key + value. |
ARCCore.ConnectionInstructionP | ARCCore | Enum | Describes class -ConnectionInstruction-. |
ARCQuery.EntityMethodKey+MethodType.Complex | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)' |
ARCCore.PSPrefix.dtr | ARCCore | EnumMember | Data, whole records. |
ARCCore.ConnectionInstructionP.ClientId | ARCCore | EnumMember | The 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. |
ARCQuery.QueryExpressionWhere+WildcardPositionType | ARCQuery | Enum | Position of wildcard in value, like '*ABC' (-AtStart-), 'ABC*' (-AtEnd-) and |
ARCCore.PSPrefix.RS | ARCCore | EnumMember | RS = Registration Stream (see -RegStream-). |
ARCCore.ConnectionInstructionP.ServerHostName | ARCCore | EnumMember | The host (DNS or IP-address) for which to connect. |
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStart | ARCQuery | EnumMember | Example: '*ABC'. |
ARCCore.PSPrefix.ES | ARCCore | EnumMember | ES = Event Stream (see -EventStream-). |
ARCCore.ConnectionInstructionP.ServerPortNo | ARCCore | EnumMember | The port number for which to connect. |
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEnd | ARCQuery | EnumMember | Example: 'ABC*'. |
ARCCore.PSPrefix.cmd | ARCCore | EnumMember | Command. |
ARCCore.StreamProcessorP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope |
AgoBrowse.Controllers.CompileController.APIMethod | AgoBrowse | ClassMember | The (only) API method that this controller supports. |
ARCCore.PKTypeAttributeP.Cardinality | ARCCore | EnumMember | Describes how multiple instances of a property is supposed to be handled. |
ARCCore.StreamProcessorP.WriteToConsole | ARCCore | EnumMember | If true then incoming data (from other nodes will be written to console. |
AgoBrowse.Controllers.CompileController.Compile | AgoBrowse | ClassMember | Compiles a hierarchical 'picture book' from the given parameter. |
ARCCore.PKTypeAttributeP.IsObligatory | ARCCore | EnumMember | True means value is obligatory. |
ARCCore.StreamProcessorP.Timestamp | ARCCore | EnumMember | The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-. |
AgoBrowse.Controllers.CompileController.ToString | AgoBrowse | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.PKTypeAttributeP.BoilerplateCodeProperties | ARCCore | EnumMember | Automatically generated boilerplate code that implements traditional setters and getters for this key. |
ARCCore.StreamProcessorP.TimestampIsOld | ARCCore | EnumMember | A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date. |
AgoBrowse.Controllers.ControllerFacade | AgoBrowse | Class | Facade for entry into the desired -RQController-. |
ARCCore.PP | ARCCore | Enum | Describes meta data for any class (property) implementing -IP-. |
ARCCore.StreamProcessorP.TimestampResolution | ARCCore | EnumMember | The time interval between each timestamp update in the -PropertyStream-. |
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2 | AgoBrowse | ClassMember | Catches all HTTP GET requests to this API. |
ARCCore.PP.Created | ARCCore | EnumMember | Timestamp when property was created in database. |
ARCCore.StreamProcessorP.DoNotStoreLocally | ARCCore | EnumMember | For -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-. |
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1 | AgoBrowse | ClassMember | Catches all HTTP POST requests to this API. |
ARCCore.PP.Cid | ARCCore | EnumMember | Creator id (entity which created this property). |
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally | ARCCore | EnumMember | Means 'do not store local origin locally but wait until it gets confirmed by core storage'. |
Namespace ARCCore | Namespace | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. | |
ARCCore.PP.Value | ARCCore | EnumMember | The actual value. |
ARCCore.StreamProcessorP.CacheDiskWrites | ARCCore | EnumMember | If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance. |
Namespace ARCDoc | Namespace | A library supporting documentation and demonstrating usage of AgoRapide. | |
ARCCore.PP.Valid | ARCCore | EnumMember | Timestamp when property was last known to be (still) valid |
ARCCore.StreamProcessorP.CopyFileStructureFromCore | ARCCore | EnumMember | If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-). |
Namespace ARCQuery | Namespace | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. | |
ARCCore.PP.Vid | ARCCore | EnumMember | Validator id, that is entity which set -Valid- for this property. |
ARCCore.StreamProcessorP.CountIncomingConnections | ARCCore | EnumMember | |
Namespace ARCAPI | Namespace | A library providing an API on top of the -PropertyStream-. | |
ARCCore.PP.Invalid | ARCCore | EnumMember | Timestamp when property was invalidated / 'deleted'. |
ARCCore.StreamProcessorP.CountOutgoingConnections | ARCCore | EnumMember | |
Namespace AgoBrowse | Namespace | ||
ARCCore.PP.Iid | ARCCore | EnumMember | Invalidator id, that is entity which set -Invalid- for this property (or removed / 'undid' the invalidation by setting the value to '0001-01-01'). |
ARCCore.StreamProcessorP.CountOutsideLocalReceiver | ARCCore | EnumMember | Count of calls to -OutsideLocalReceiver-. |
Namespace AgoBrowse.Controllers | Namespace | ||
ARCCore.PP.ExceptionText | ARCCore | EnumMember | General property for logging of exceptions, usually set through -HandleException-. |
ARCCore.StreamProcessorP.CountReceiveLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- with -HasLocalOrigin-. |
ARCCore.PConcurrentP | ARCCore | Enum | Describes class -PConcurrent-. |
ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- not with -HasLocalOrigin-. |
ARCCore.PConcurrentP.Heartbeat | ARCCore | EnumMember | |
ARCCore.StorageFileP | ARCCore | Enum | Describes class -StorageFile-. |
ARCCore.ActualConnectionP | ARCCore | Enum | Describes class -ActualConnection-. |
ARCCore.StorageFileP.Filename | ARCCore | EnumMember | |
ARCCore.ActualConnectionP.Id | ARCCore | EnumMember | When connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection. |
ARCDoc.Apple.Name | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCCore.ConnectionInstructionP.ConnectionId | ARCCore | EnumMember | Usually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-. |
ARCDoc.Banana | ARCDoc | Class | Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency. |
ARCCore.ConnectionInstructionP.DataTransferDirection | ARCCore | EnumMember | |
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) |
ARCCore.ConnectionInstructionP.Subscription | ARCCore | EnumMember | The actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server. |
ARCDoc.Banana.Colour | ARCDoc | ClassMember | Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc) |
ARCCore.ConnectionInstructionP.MultipleConnectionUsage | ARCCore | EnumMember | |
ARCDoc.Demonstrator | ARCDoc | Class | Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-. |
ARCCore.ConnectionInstructionP.Sharding | ARCCore | EnumMember | |
ARCDoc.Demonstrator.DemonstratePropertyAccessApple | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Apple- class. |
ARCCore.MultipleConnectionUsage | ARCCore | Enum | Enables fault-tolerance by describing use of multiple connections |
ARCDoc.Demonstrator.DemonstratePropertyAccessOrange | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Orange- class. |
ARCCore.MultipleConnectionUsage.Admin | ARCCore | EnumMember | Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make. |
ARCDoc.Demonstrator.DemonstratePropertyAccessBanana | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Banana- class. |
ARCCore.MultipleConnectionUsage.RoundRobin | ARCCore | EnumMember | This connection to be used in a turn based system, together with other connections with -RoundRobin-. |
ARCDoc.Demonstrator.DemonstrateITypeDescriber | ARCDoc | ClassMember | Demonstrates use of -ITypeDescriber- for describing single-property values. |
ARCCore.MultipleConnectionUsage.Simultaneous | ARCCore | EnumMember | This connection to be used simultaneously with other connections with -Simultaneous- |
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage | ARCDoc | ClassMember | Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage. |
ARCCore.StreamProcessorP | ARCCore | Enum | Describes class -StreamProcessor-. |
ARCDoc.Demonstrator.DemonstratePropertyStream | ARCDoc | ClassMember | Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console. |
ARCCore.StreamProcessorP.LocalStorageFolder | ARCCore | EnumMember | The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar |
ARCDoc.Demonstrator.DemonstrateBareBonesClient | ARCDoc | ClassMember | Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET. |
ARCCore.StreamProcessorP.IndividualStorageFileSize | ARCCore | EnumMember | Max size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-. |
ARCDoc.Demonstrator.DemonstrateLogConsole | ARCDoc | ClassMember | Demonstrates a quite simple log console. |
ARCCore.StreamProcessorP.CurrentlyInitializing | ARCCore | EnumMember | Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them). |
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient | ARCDoc | ClassMember | Demonstrates use of -StreamProcessor- as a general client. |
ARCCore.StreamProcessorP.ClientUpdatePositionPath | ARCCore | EnumMember | Complete path to file containing -ClientUpdatePosition-. |
ARCDoc.Orange | ARCDoc | Class | Inherits -PExact- for probably the best compromise between memory consumption and easy of development. |
ARCCore.StreamProcessorP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
ARCDoc.Orange.SetPVDirect | ARCDoc | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
ARCCore.StreamProcessorP.IncomingConnectionsPortNo | ARCCore | EnumMember | If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-). |
ARCDoc.DocLinkCollection | ARCDoc | Class | Contains a collection of -DocLink- objects. |
ARCCore.StorageFileP.Hash | ARCCore | EnumMember | Hash 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 |
ARCDoc.DocLinkCollection.Create | ARCDoc | ClassMember | Notes all locations and their positions in the hierarchical directory structure. |
ARCCore.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
ARCDoc.DocLinkCollection.InsertLinks Overload1 | ARCDoc | ClassMember | Does -LinkInsertionInDocumentation- on the given HTML content. |
ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
ARCDoc.DocLinkCollection.InsertLinks Overload2 | ARCDoc | ClassMember | See overload with 'contentLocation' as parameter for documentation. |
ARCCore.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
ARCDoc.DocLinkCollection.TryGetP | ARCDoc | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCCore.DataTransferDirection | ARCCore | Enum | Direction for transfer of data. |
ARCDoc.DocLinkCollection.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). |
ARCCore.DataTransferDirection.Send | ARCCore | EnumMember | Like -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-. |
ARCDoc.DocLinkCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.DataTransferDirection.Receive | ARCCore | EnumMember | Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-. |
ARCDoc.DocLinkResolution | ARCDoc | Class | Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances). |
ARCCore.TPropertyKeyEnum | ARCCore | Enum | Placeholder for any enum type suitable as generic type parameter for -PExact-. |
ARCDoc.DocLinkResolution.ToHTMLSimpleSingle | ARCDoc | ClassMember | Gives a friendly description about possible targets for LinkWord-. |
Assembly ARCDoc | Assembly | A library supporting documentation and demonstrating usage of AgoRapide. | |
ARCDoc.DocLinkResolution.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 | ARCDoc | Class | The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-. |
ARCDoc.DocLinkResolution.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.AddName | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCDoc.DocLinkResolution.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Apple.GetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCDoc.DocLinkResolutionCollection | ARCDoc | Class | Contains a collection of -DocLinkResolution- objects. |
ARCDoc.Apple.TryGetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
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.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.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.Documentator | ARCDoc | Class | General class for documenting AgoRapide and also your own -ApplicationSpecificCode-. |
ARCDoc.Orange.GetPVDirect | ARCDoc | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
ARCDoc.Documentator.CreateAndInsert | ARCDoc | ClassMember | Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies. |
ARCDoc.Orange.TryGetPVDirect | ARCDoc | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
ARCDoc.Documentator.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
ARCDoc.Orange.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Documentator.CreateHTOCStandard | ARCDoc | ClassMember | Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'. |
ARCDoc.Orange.Name | ARCDoc | ClassMember | See -Name- for more information. |
ARCDoc.Documentator.CreateHTOCNamespace | ARCDoc | ClassMember | Creates a table of contents structured by namespace |
ARCDoc.Orange.Storage | ARCDoc | ClassMember | Uses int-value of -__enum- minus 1 as index. |
ARCDoc.Documentator.CreateHTOCInheritance | ARCDoc | ClassMember | Creates a table of contents structured by inheritance (classes and interfaces only, not members). |
ARCDoc.SomeAppComponent | ARCDoc | Class | Demonstrates how also your actual application classes, not only your data classes, should implement -IP-. |
ARCDoc.Documentator.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.MethodC | ARCDoc | ClassMember | Note structured format in logging. |
ARCDoc.Documentator.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.SomeAppComponent.MethodD | ARCDoc | ClassMember | Same as MethodC- but returns data ('Func<string>()' instead of 'Action()') |
ARCDoc.Documentator.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Documentator.DocLinks | ARCDoc | ClassMember | Set by -CreateAndInsert-. |
ARCDoc.Documentator.DocLinkResolutionLocation | ARCDoc | ClassMember | Default position within the global storage context of doc link resolution pages. |
ARCDoc.DummyEnum | ARCDoc | Class | TODO: Document better what this is for (and change name) |
ARCDoc.DummyEnum.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.DummyEnum.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.DummyEnum.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Extensions | ARCDoc | Class | Contains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML. |
ARCDoc.Extensions.ToHTMLSimpleSingleRecursive | ARCDoc | ClassMember | Calls -ToHTMLSimpleSingle- recursively. |
ARCDoc.Extensions.ToHTMLSimpleSingle | ARCDoc | ClassMember | Creates a simple HTML representation of the given parameter. |
ARCDoc.Extensions.ToHTMLSimpleSingleInternal | ARCDoc | ClassMember | Hack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-. |
ARCDoc.Extensions.ToHTMLSimpleAsTableRow | ARCDoc | ClassMember | Creates a simple HTML representation of the given parameter as a single two column row (Key, Value) in a table. |
ARCDoc.Extensions.DescribeValue | ARCDoc | ClassMember | Describes the value contained withing an -IKIP- (-P-). |
ARCDoc.Extensions.ValueToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Value with description as a 'tooltip'. |
ARCDoc.Extensions.KeyToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Key with description as a 'tooltip'. |
ARCDoc.Extensions.GetHelptextHTML | ARCDoc | ClassMember | Returns content of -Description- and -LongDescription-. |
ARCDoc.HLocation | ARCDoc | Class | Simple class describing the location of a single -IP- instance within some hierarhical context. |
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.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.HLocation.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.HLocation.Content | ARCDoc | ClassMember | The Content object is not stored within the standard -IP--mechanism. |
ARCDoc.HLocationCollection | ARCDoc | Class | Contains a collection of -HLocation- objects. |
ARCDoc.HLocationCollection.Create | ARCDoc | ClassMember | Transforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects. |
ARCDoc.HLocationCollection.WriteAllContentHTMLToDisk | ARCDoc | ClassMember | Writes all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-. |
ARCDoc.SomeAppComponentP.SomeCountValue | ARCDoc | EnumMember | |
ARCDoc.SomeAppComponentP.SomeCountValueNotToBeLogged | ARCDoc | EnumMember | |
ARCDoc.DocFragP | ARCDoc | Enum | Describes class -DocFrag-. |
ARCDoc.DocFragP.DocFragType | ARCDoc | EnumMember | |
ARCDoc.DocFragP.Assembly | ARCDoc | EnumMember | Name of the assembly in which this fragment resides. |
ARCDoc.DocFragP.Namespace | ARCDoc | EnumMember | Namespace in which this fragment resides. |
ARCDoc.DocFragP.ParentNamespace | ARCDoc | EnumMember | Parent namespace of namespace in which this fragment resides. |
ARCDoc.DocFragP.Type | ARCDoc | EnumMember | Type of class or enum which this fragment describes (also relevant for class or enum member). |
ARCDoc.DocFragP.Name | ARCDoc | EnumMember | As simple a name as practical usable. Often not unique within a greater context. |
ARCDoc.DocFragP.IsInherited | ARCDoc | EnumMember | Relevant for class members. TRUE if method is inherited from a base type. |
ARCDoc.DocFragP.IsInheritedDoc | ARCDoc | EnumMember | Relevant for class members (methods). |
ARCDoc.DocFragP.Lines | ARCDoc | EnumMember | Number of lines of text in -Description- and -LongDescription- for this fragment. |
ARCDoc.DocFragP.Attribute | ARCDoc | EnumMember | The -BaseAttribute- or -PK- from which this -DocFrag- originates. |
ARCDoc.DocFragType | ARCDoc | Enum | Type of documentation fragment, like -Assembly-, -Class- or -ClassMember-. |
ARCDoc.DocFragType.Assembly | ARCDoc | EnumMember | |
ARCDoc.DocFragType.Namespace | ARCDoc | EnumMember | |
ARCDoc.DocFragType.Class | ARCDoc | EnumMember | Does also include interfaces. |
Generated 2025-07-11 02:16:36.179 UTC