Home
Categories
Dictionary
Download
Project Details
Changes Log
What Links Here
How To
Syntax
FAQ
License

CSharp generic API



The "csharp" generic API models the C# language elements.

Structure of the API

The structure of the API is the following:
  • Only "class", "struct", and "enum" parent elements can be at the root of each API
  • A "class" parent element can have "method" or "field" children. Note that "property", "event", parent element is "field", and "operator" parent element is "method"
  • A "struct" parent element can have "field" children
  • An "enum" parent element can have "method" and "constant" children. Note that an enum state is a "constant"
Note that the elements described here are the parent type of the element. See Generic apidocs API types for the list of parent element for each API element.
csapidoc

List of managed types

The following table presents the list of parent types which are managed by the CSharp generic API.
Parent Type Top Element Comment
class Yes Represents a class
struct Yes Represents a structure
enum Yes Represents an enum
method No Represents a method or an operation
field No Represents a class field, a struture field, a property, or an event
constant No Represents a constant used for enum states
argument No Represents an argument

See also


Categories: configuration

docJGenerator Copyright (c) 2016-2023 Herve Girod. All rights reserved.