Skip to content

Commit

Permalink
update docs, strip assembly info from generic types in docs, remove e…
Browse files Browse the repository at this point in the history
…rroneous entries for indexers
  • Loading branch information
atenfyr committed Aug 19, 2024
1 parent 72910c9 commit dd84ade
Show file tree
Hide file tree
Showing 85 changed files with 168 additions and 401 deletions.
40 changes: 40 additions & 0 deletions docs/correct_pages.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import glob, re

SUBSTRINGS_TO_CHANGE = {
re.escape("""### **Item**
```csharp
public PropertyData Item { get; set; }
```
#### Property Value
[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>
"""): "",

re.escape("""### **Item**
```csharp
public Export Item { get; set; }
```
#### Property Value
[Export](./uassetapi.exporttypes.export.md)<br>
"""): "",

r", [\S]+?, Version=[\d\.]+, Culture=.+?, PublicKeyToken=.+?\]": "]",


}

for file in glob.glob("src/api/*.md"):
dat = ""
with open(file, "r") as f:
dat = f.read()
for entry in SUBSTRINGS_TO_CHANGE:
dat = re.sub(entry, SUBSTRINGS_TO_CHANGE[entry], dat)
with open(file, "w") as f:
f.write(dat)
1 change: 1 addition & 0 deletions docs/generate_docs.bat
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ rd /S /Q "%startdir%\src\api"
cd %startdir%
move ".\src\api\index.md" .
python correct_summary.py
python correct_pages.py
del index.md
1 change: 1 addition & 0 deletions docs/generate_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ startdir="$(pwd)"
)
mv src/api/index.md .
python correct_summary.py
python correct_pages.py
rm index.md
30 changes: 0 additions & 30 deletions docs/src/api/uassetapi.exporttypes.classexport.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,36 +356,6 @@ public UnrealPackage Asset;

## Properties

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **OuterIndex**

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage
Expand Down
30 changes: 0 additions & 30 deletions docs/src/api/uassetapi.exporttypes.datatableexport.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,36 +235,6 @@ public UnrealPackage Asset;

## Properties

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **OuterIndex**

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage
Expand Down
30 changes: 0 additions & 30 deletions docs/src/api/uassetapi.exporttypes.enumexport.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,36 +237,6 @@ public UnrealPackage Asset;

## Properties

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **OuterIndex**

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage
Expand Down
30 changes: 0 additions & 30 deletions docs/src/api/uassetapi.exporttypes.fieldexport.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,36 +235,6 @@ public UnrealPackage Asset;

## Properties

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **OuterIndex**

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage
Expand Down
2 changes: 1 addition & 1 deletion docs/src/api/uassetapi.exporttypes.fstringtable.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Namespace: UAssetAPI.ExportTypes
A string table. Holds Key-&gt;SourceString pairs of text.

```csharp
public class FStringTable : UAssetAPI.UnrealTypes.TMap`2[[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.1.0, Culture=neutral, PublicKeyToken=null],[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.1.0, Culture=neutral, PublicKeyToken=null]], UAssetAPI.UnrealTypes.IOrderedDictionary`2[[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.1.0, Culture=neutral, PublicKeyToken=null],[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.1.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.IDictionary`2[[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.1.0, Culture=neutral, PublicKeyToken=null],[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.1.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.ICollection`1[[System.Collections.Generic.KeyValuePair`2[[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.1.0, Culture=neutral, PublicKeyToken=null],[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.1.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.IEnumerable`1[[System.Collections.Generic.KeyValuePair`2[[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.1.0, Culture=neutral, PublicKeyToken=null],[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.1.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.IEnumerable, System.Collections.Specialized.IOrderedDictionary, System.Collections.IDictionary, System.Collections.ICollection
public class FStringTable : UAssetAPI.UnrealTypes.TMap`2[[UAssetAPI.UnrealTypes.FString],[UAssetAPI.UnrealTypes.FString]], UAssetAPI.UnrealTypes.IOrderedDictionary`2[[UAssetAPI.UnrealTypes.FString],[UAssetAPI.UnrealTypes.FString]], System.Collections.Generic.IDictionary`2[[UAssetAPI.UnrealTypes.FString],[UAssetAPI.UnrealTypes.FString]], System.Collections.Generic.ICollection`1[[System.Collections.Generic.KeyValuePair`2[[UAssetAPI.UnrealTypes.FString],[UAssetAPI.UnrealTypes.FString]]]], System.Collections.Generic.IEnumerable`1[[System.Collections.Generic.KeyValuePair`2[[UAssetAPI.UnrealTypes.FString],[UAssetAPI.UnrealTypes.FString]]]], System.Collections.IEnumerable, System.Collections.Specialized.IOrderedDictionary, System.Collections.IDictionary, System.Collections.ICollection
```

Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TMap&lt;FString, FString&gt;](./uassetapi.unrealtypes.tmap-2.md) → [FStringTable](./uassetapi.exporttypes.fstringtable.md)<br>
Expand Down
30 changes: 0 additions & 30 deletions docs/src/api/uassetapi.exporttypes.functionexport.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,36 +289,6 @@ public UnrealPackage Asset;

## Properties

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **OuterIndex**

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage
Expand Down
30 changes: 0 additions & 30 deletions docs/src/api/uassetapi.exporttypes.levelexport.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,36 +275,6 @@ public UnrealPackage Asset;

## Properties

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **OuterIndex**

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage
Expand Down
30 changes: 0 additions & 30 deletions docs/src/api/uassetapi.exporttypes.normalexport.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,36 +229,6 @@ public UnrealPackage Asset;

## Properties

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **OuterIndex**

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage
Expand Down
30 changes: 0 additions & 30 deletions docs/src/api/uassetapi.exporttypes.propertyexport.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,36 +235,6 @@ public UnrealPackage Asset;

## Properties

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **OuterIndex**

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage
Expand Down
30 changes: 0 additions & 30 deletions docs/src/api/uassetapi.exporttypes.stringtableexport.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,36 +235,6 @@ public UnrealPackage Asset;

## Properties

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **Item**

```csharp
public PropertyData Item { get; set; }
```

#### Property Value

[PropertyData](./uassetapi.propertytypes.objects.propertydata.md)<br>

### **OuterIndex**

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage
Expand Down
Loading

0 comments on commit dd84ade

Please sign in to comment.