Skip to content

Commit 20cdc8f

Browse files
committed
change from oM to api documentation
1 parent fea5fab commit 20cdc8f

1,481 files changed

Lines changed: 19631 additions & 19631 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

SchemaDocumentationGenerator/SchemaDocumentationGenerator/Program.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
{
3535
if (!(type.IsAbstract && type.IsSealed) && (type.IsEnum || typeof(IObject).IsAssignableFrom(type)))
3636
{
37-
TypeToMarkdown.WriteTypeToMarkdown(@"C:\Github\om_documentation\docs\", type, methods);
37+
TypeToMarkdown.WriteTypeToMarkdown(@"C:\Github\api_documentation\docs\", type, methods);
3838
}
3939
}
4040
}

SchemaDocumentationGenerator/SchemaDocumentationGenerator/TypeGeneration/DocumentationLink.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ private static string GetDocumentLink(this Type type)
101101
string categoryPath;
102102
if (Settings.AssemblyCategory.TryGetValue(type.Assembly.GetName().Name, out categoryPath))
103103
{
104-
string link = $"/om_documentation/oM/{categoryPath}/{type.BHoMTypeFullName().Replace("`", "%60").Replace(".", "/")}";
104+
string link = $"/api_documentation/oM/{categoryPath}/{type.BHoMTypeFullName().Replace("`", "%60").Replace(".", "/")}";
105105
m_docLinks[type] = link;
106106
return link;
107107
}

docs/oM/Adapter/Adapters/AGS/AGSSettings.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ General settings for any Adapter, to be specified when instantiating the Adapter
1212

1313
???+ bhom "The AGSSettings in inheriting from the following base type(s) and implements the following interfaces:"
1414

15-
- Adapter.[AdapterSettings](/om_documentation/oM/Framework/Adapter/AdapterSettings)
16-
- Base.[IObject](/om_documentation/oM/Framework/Base/IObject)
15+
- Adapter.[AdapterSettings](/api_documentation/oM/Framework/Adapter/AdapterSettings)
16+
- Base.[IObject](/api_documentation/oM/Framework/Base/IObject)
1717

1818

1919
## Properties
@@ -27,7 +27,7 @@ The following properties are defined on the class
2727
| Name | Type | Description | Quantity |
2828
|------------------|------------------|------------------|------------------|
2929
| BlankGeology | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Only implemented when the BlankGeologyStrategy is set to replacement. <br>If blank geology occurs in the GEOL_GEOL columns, assign a geology to replace it e.g. Made ground. | - |
30-
| BlankGeologyStraegy | [BlankGeologyStrategy](/om_documentation/oM/Adapter/Adapters/AGS/BlankGeologyStrategy) | The strategy used to handle blank geology entries. | - |
30+
| BlankGeologyStraegy | [BlankGeologyStrategy](/api_documentation/oM/Adapter/Adapters/AGS/BlankGeologyStrategy) | The strategy used to handle blank geology entries. | - |
3131

3232

3333
### Inherited properties
@@ -36,9 +36,9 @@ The following properties are inherited from the base class of the object
3636
| Name | Type | Description | Quantity |
3737
|------------------|------------------|------------------|------------------|
3838
| WrapNonBHoMObjects | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If your Toolkit needs support for non-BHoM objects, set this to true. | - |
39-
| DefaultPushType | [PushType](/om_documentation/oM/Framework/Adapter/PushType) | If your Toolkit does not support the Full Push (FullCRUD method), you can select another behaviour here (e.g. CreateOnly). | - |
39+
| DefaultPushType | [PushType](/api_documentation/oM/Framework/Adapter/PushType) | If your Toolkit does not support the Full Push (FullCRUD method), you can select another behaviour here (e.g. CreateOnly). | - |
4040
| CloneBeforePush | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Deep clones the objects before Pushing them.As the objects get modified during the Push (e.g. their externalId is added to them),this avoids backpropagation in visual programming environments like Grasshopper. | - |
41-
| DefaultPullType | [PullType](/om_documentation/oM/Framework/Adapter/PullType) | - | - |
41+
| DefaultPullType | [PullType](/api_documentation/oM/Framework/Adapter/PullType) | - | - |
4242
| HandleDependencies | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If your adapter does not define DependencyTypes, this can be set to false for performance. | - |
4343
| HandlePriorities | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | - | - |
4444
| UseAdapterId | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | - | - |

docs/oM/Adapter/Adapters/CarbonQueryDatabase/CQDConfig.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ This Config can be specified in the `ActionConfig` input of any Adapter Action (
1212

1313
???+ bhom "The CQDConfig in inheriting from the following base type(s) and implements the following interfaces:"
1414

15-
- Adapter.[ActionConfig](/om_documentation/oM/Framework/Adapter/ActionConfig)
16-
- Base.[IObject](/om_documentation/oM/Framework/Base/IObject)
15+
- Adapter.[ActionConfig](/api_documentation/oM/Framework/Adapter/ActionConfig)
16+
- Base.[IObject](/api_documentation/oM/Framework/Base/IObject)
1717

1818

1919
## Properties
@@ -26,7 +26,7 @@ The following properties are defined on the class
2626

2727
| Name | Type | Description | Quantity |
2828
|------------------|------------------|------------------|------------------|
29-
| Type | [EPDType](/om_documentation/oM/Analytical/LifeCycleAssessment/EPDType) | The Type of Environmental Product Declaration | - |
29+
| Type | [EPDType](/api_documentation/oM/Analytical/LifeCycleAssessment/EPDType) | The Type of Environmental Product Declaration | - |
3030
| Id | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Specifies ID to search and return objects for in CarbonQueryDatabase. If this is specified it supersedes other input parameters. | - |
3131
| Count | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | Sets maximum amount of items to return from CarbonQueryDatabase | - |
3232
| NameLike | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Specifies string to search and return objects for in CarbonQueryDatabase, ie RedBuilt RedLam LVL | - |
@@ -40,7 +40,7 @@ The following properties are inherited from the base class of the object
4040
|------------------|------------------|------------------|------------------|
4141
| WrapNonBHoMObjects | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If true, the Push action wraps any non-BHoM type into a BH.oM.Adapter.ObjectWrapper, allowing them to make use of the full Adapter workflow. | - |
4242
| AllowHashForComparing | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If true and if no specific EqualityComparer is found for the type, Diffing hashes are computed and used to compare the objects. | - |
43-
| DiffingConfig | [DiffingConfig](/om_documentation/oM/Framework/Diffing/DiffingConfig) | Configurations for the Diffing hashing. Requires `AllowHashForComparing` to be set to true. | - |
43+
| DiffingConfig | [DiffingConfig](/api_documentation/oM/Framework/Diffing/DiffingConfig) | Configurations for the Diffing hashing. Requires `AllowHashForComparing` to be set to true. | - |
4444

4545

4646
## Code and Schema

docs/oM/Adapter/Adapters/ETABS/DatabaseSettings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: DatabaseSettings
1212

1313
???+ bhom "The DatabaseSettings in inheriting from the following base type(s) and implements the following interfaces:"
1414

15-
- Base.[IObject](/om_documentation/oM/Framework/Base/IObject)
15+
- Base.[IObject](/api_documentation/oM/Framework/Base/IObject)
1616

1717

1818
## Properties
@@ -25,7 +25,7 @@ The following properties are defined on the class
2525

2626
| Name | Type | Description | Quantity |
2727
|------------------|------------------|------------------|------------------|
28-
| SectionDatabase | [SectionDatabase](/om_documentation/oM/Adapter/Adapters/ETABS/SectionDatabase) | The ETABS defined section database to read sections from if the name of the sections you push share a name with one avalible in the database | - |
28+
| SectionDatabase | [SectionDatabase](/api_documentation/oM/Adapter/Adapters/ETABS/SectionDatabase) | The ETABS defined section database to read sections from if the name of the sections you push share a name with one avalible in the database | - |
2929

3030

3131
## Code and Schema

docs/oM/Adapter/Adapters/ETABS/ETABSId.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ title: ETABSId
1212

1313
???+ bhom "The ETABSId in inheriting from the following base type(s) and implements the following interfaces:"
1414

15-
- Base.[IAdapterId](/om_documentation/oM/Framework/Base/IAdapterId)
16-
- Base.[IFragment](/om_documentation/oM/Framework/Base/IFragment)
17-
- Base.[IObject](/om_documentation/oM/Framework/Base/IObject)
18-
- Base.[IPersistentAdapterId](/om_documentation/oM/Framework/Base/IPersistentAdapterId)
15+
- Base.[IAdapterId](/api_documentation/oM/Framework/Base/IAdapterId)
16+
- Base.[IFragment](/api_documentation/oM/Framework/Base/IFragment)
17+
- Base.[IObject](/api_documentation/oM/Framework/Base/IObject)
18+
- Base.[IPersistentAdapterId](/api_documentation/oM/Framework/Base/IPersistentAdapterId)
1919

2020

2121
## Properties

docs/oM/Adapter/Adapters/ETABS/Elements/AutoLengthOffset.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ title: AutoLengthOffset
1212

1313
???+ bhom "The AutoLengthOffset in inheriting from the following base type(s) and implements the following interfaces:"
1414

15-
- Base.[IFragment](/om_documentation/oM/Framework/Base/IFragment)
16-
- Base.[IObject](/om_documentation/oM/Framework/Base/IObject)
15+
- Base.[IFragment](/api_documentation/oM/Framework/Base/IFragment)
16+
- Base.[IObject](/api_documentation/oM/Framework/Base/IObject)
1717

1818

1919
## Properties

docs/oM/Adapter/Adapters/ETABS/Elements/Diaphragm.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ title: Diaphragm
1212

1313
???+ bhom "The Diaphragm in inheriting from the following base type(s) and implements the following interfaces:"
1414

15-
- Base.[BHoMObject](/om_documentation/oM/Framework/Base/BHoMObject)
16-
- Base.[IBHoMObject](/om_documentation/oM/Framework/Base/IBHoMObject)
17-
- Base.[IObject](/om_documentation/oM/Framework/Base/IObject)
18-
- Base.[IFragment](/om_documentation/oM/Framework/Base/IFragment)
15+
- Base.[BHoMObject](/api_documentation/oM/Framework/Base/BHoMObject)
16+
- Base.[IBHoMObject](/api_documentation/oM/Framework/Base/IBHoMObject)
17+
- Base.[IObject](/api_documentation/oM/Framework/Base/IObject)
18+
- Base.[IFragment](/api_documentation/oM/Framework/Base/IFragment)
1919

2020

2121
## Properties
@@ -28,7 +28,7 @@ The following properties are defined on the class
2828

2929
| Name | Type | Description | Quantity |
3030
|------------------|------------------|------------------|------------------|
31-
| Rigidity | [DiaphragmType](/om_documentation/oM/Adapter/Adapters/ETABS/DiaphragmType) | - | - |
31+
| Rigidity | [DiaphragmType](/api_documentation/oM/Adapter/Adapters/ETABS/DiaphragmType) | - | - |
3232

3333

3434
### Inherited properties
@@ -38,7 +38,7 @@ The following properties are inherited from the base class of the object
3838
|------------------|------------------|------------------|------------------|
3939
| BHoM_Guid | [Guid](https://learn.microsoft.com/en-us/dotnet/api/System.Guid?view=netstandard-2.0) | - | - |
4040
| Name | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
41-
| Fragments | [FragmentSet](/om_documentation/oM/Framework/Base/FragmentSet) | - | - |
41+
| Fragments | [FragmentSet](/api_documentation/oM/Framework/Base/FragmentSet) | - | - |
4242
| Tags | [HashSet](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.HashSet-1?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0)&gt; | - | - |
4343
| CustomData | [Dictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0), [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0)&gt; | - | - |
4444

docs/oM/Adapter/Adapters/ETABS/Elements/InsertionPoint.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ title: InsertionPoint
1212

1313
???+ bhom "The InsertionPoint in inheriting from the following base type(s) and implements the following interfaces:"
1414

15-
- Base.[IFragment](/om_documentation/oM/Framework/Base/IFragment)
16-
- Base.[IObject](/om_documentation/oM/Framework/Base/IObject)
15+
- Base.[IFragment](/api_documentation/oM/Framework/Base/IFragment)
16+
- Base.[IObject](/api_documentation/oM/Framework/Base/IObject)
1717

1818

1919
## Properties
@@ -26,7 +26,7 @@ The following properties are defined on the class
2626

2727
| Name | Type | Description | Quantity |
2828
|------------------|------------------|------------------|------------------|
29-
| BarInsertionPoint | [BarInsertionPoint](/om_documentation/oM/Adapter/Adapters/ETABS/BarInsertionPoint) | - | - |
29+
| BarInsertionPoint | [BarInsertionPoint](/api_documentation/oM/Adapter/Adapters/ETABS/BarInsertionPoint) | - | - |
3030
| ModifyStiffness | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Transform frame stiffness for offsets from centroid for non-P/T floors | - |
3131

3232

docs/oM/Adapter/Adapters/ETABS/Elements/Pier.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ title: Pier
1212

1313
???+ bhom "The Pier in inheriting from the following base type(s) and implements the following interfaces:"
1414

15-
- Base.[BHoMObject](/om_documentation/oM/Framework/Base/BHoMObject)
16-
- Base.[IBHoMObject](/om_documentation/oM/Framework/Base/IBHoMObject)
17-
- Base.[IObject](/om_documentation/oM/Framework/Base/IObject)
18-
- Base.[IFragment](/om_documentation/oM/Framework/Base/IFragment)
15+
- Base.[BHoMObject](/api_documentation/oM/Framework/Base/BHoMObject)
16+
- Base.[IBHoMObject](/api_documentation/oM/Framework/Base/IBHoMObject)
17+
- Base.[IObject](/api_documentation/oM/Framework/Base/IObject)
18+
- Base.[IFragment](/api_documentation/oM/Framework/Base/IFragment)
1919

2020

2121
## Properties
@@ -27,7 +27,7 @@ The following properties are inherited from the base class of the object
2727
|------------------|------------------|------------------|------------------|
2828
| BHoM_Guid | [Guid](https://learn.microsoft.com/en-us/dotnet/api/System.Guid?view=netstandard-2.0) | - | - |
2929
| Name | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
30-
| Fragments | [FragmentSet](/om_documentation/oM/Framework/Base/FragmentSet) | - | - |
30+
| Fragments | [FragmentSet](/api_documentation/oM/Framework/Base/FragmentSet) | - | - |
3131
| Tags | [HashSet](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.HashSet-1?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0)&gt; | - | - |
3232
| CustomData | [Dictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0), [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0)&gt; | - | - |
3333

0 commit comments

Comments
 (0)