Skip to content

Commit

Permalink
fix(docs): Fix an issue with array<> in doc
Browse files Browse the repository at this point in the history
Markdown thinks `<string>` is a HTML tag, and doesn't show it.
Fix it by replacing `array<` with `array&lt;` during doc gneeration.
  • Loading branch information
narnaud committed Jul 5, 2024
1 parent 82a5ef1 commit 5c839b1
Show file tree
Hide file tree
Showing 23 changed files with 105 additions and 96 deletions.
4 changes: 2 additions & 2 deletions docs/API/script/action.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import Script
|bool|**[checked](#checked)**|
|string|**[iconPath](#iconPath)**|
|string|**[id](#id)**|
|array<[Shortcut](../script/shortcut.md)>|**[shortcuts](#shortcuts)**|
|array&lt;[Shortcut](../script/shortcut.md)>|**[shortcuts](#shortcuts)**|
|string|**[statusTip](#statusTip)**|
|string|**[toolTip](#toolTip)**|

Expand All @@ -31,7 +31,7 @@ This property holds the fileName for the icon of the action.

This property holds the id of the action.

#### <a name="shortcuts"></a>array<[Shortcut](../script/shortcut.md)> **shortcuts**
#### <a name="shortcuts"></a>array&lt;[Shortcut](../script/shortcut.md)> **shortcuts**

This property holds all the shortcuts associated with the action.

Expand Down
12 changes: 6 additions & 6 deletions docs/API/script/codedocument.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ Inherited properties: [TextDocument properties](../script/textdocument.md#proper
|-|-|
|[Symbol](../script/symbol.md) |**[findSymbol](#findSymbol)**(string name, int options = TextDocument.NoFindFlags)|
|string |**[hover](#hover)**()|
|array<[QueryMatch](../script/querymatch.md)> |**[query](#query)**(string query)|
|array&lt;[QueryMatch](../script/querymatch.md)> |**[query](#query)**(string query)|
|[QueryMatch](../script/querymatch.md) |**[queryFirst](#queryFirst)**(string query)|
|array<[QueryMatch](../script/querymatch.md)> |**[queryInRange](#queryInRange)**([RangeMark](../script/rangemark.md) range, string query)|
|array&lt;[QueryMatch](../script/querymatch.md)> |**[queryInRange](#queryInRange)**([RangeMark](../script/rangemark.md) range, string query)|
||**[selectSymbol](#selectSymbol)**(string name, int options = TextDocument.NoFindFlags)|
|[Symbol](../script/symbol.md) |**[symbolUnderCursor](#symbolUnderCursor)**()|
|array<[Symbol](../script/symbol.md)> |**[symbols](#symbols)**()|
|array&lt;[Symbol](../script/symbol.md)> |**[symbols](#symbols)**()|

Inherited methods: [TextDocument methods](../script/textdocument.md#methods)

Expand Down Expand Up @@ -53,7 +53,7 @@ from is deconstructed.
Returns information about the symbol at the current cursor position.
The result of this call is a plain string that may be formatted in Markdown.

#### <a name="query"></a>array<[QueryMatch](../script/querymatch.md)> **query**(string query)
#### <a name="query"></a>array&lt;[QueryMatch](../script/querymatch.md)> **query**(string query)

Runs the given Tree-sitter `query` and returns the list of matches.

Expand All @@ -75,7 +75,7 @@ queries](https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matchin
Also see: [Tree-sitter in Knut](../../getting-started/treesitter.md)
Core::QueryMatchList CodeDocument::query(const QString &query)

#### <a name="queryInRange"></a>array<[QueryMatch](../script/querymatch.md)> **queryInRange**([RangeMark](../script/rangemark.md) range, string query)
#### <a name="queryInRange"></a>array&lt;[QueryMatch](../script/querymatch.md)> **queryInRange**([RangeMark](../script/rangemark.md) range, string query)

Searches for the given `query`, but only in the provided `range`.

Expand All @@ -98,7 +98,7 @@ This function may return symbols that are not returned by the `symbols()` or `cu
as these only return high-level symbols, like classes and functions, but not symbols within functions.
`symbolUnderCursor()` can however return these Symbols.

#### <a name="symbols"></a>array<[Symbol](../script/symbol.md)> **symbols**()
#### <a name="symbols"></a>array&lt;[Symbol](../script/symbol.md)> **symbols**()

Returns the list of symbols in the current document.

Expand Down
16 changes: 8 additions & 8 deletions docs/API/script/cppdocument.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ Inherited properties: [CodeDocument properties](../script/codedocument.md#proper
|[CppDocument](../script/cppdocument.md) |**[openHeaderSource](#openHeaderSource)**()|
|QStringList |**[primitiveTypes](#primitiveTypes)**()|
|[QueryMatch](../script/querymatch.md) |**[queryClassDefinition](#queryClassDefinition)**(string className)|
|array<[QueryMatch](../script/querymatch.md)> |**[queryFunctionCall](#queryFunctionCall)**(string functionName)|
|array<[QueryMatch](../script/querymatch.md)> |**[queryFunctionCall](#queryFunctionCall)**(string functionName, array<string> argumentCaptures)|
|array&lt;[QueryMatch](../script/querymatch.md)> |**[queryFunctionCall](#queryFunctionCall)**(string functionName)|
|array&lt;[QueryMatch](../script/querymatch.md)> |**[queryFunctionCall](#queryFunctionCall)**(string functionName, array&lt;string> argumentCaptures)|
|[QueryMatch](../script/querymatch.md) |**[queryMember](#queryMember)**(string className, string memberName)|
|array<[QueryMatch](../script/querymatch.md)> |**[queryMethodDeclaration](#queryMethodDeclaration)**(string className, string functionName)|
|array<[QueryMatch](../script/querymatch.md)> |**[queryMethodDefinition](#queryMethodDefinition)**(string scope, string methodName)|
|array&lt;[QueryMatch](../script/querymatch.md)> |**[queryMethodDeclaration](#queryMethodDeclaration)**(string className, string functionName)|
|array&lt;[QueryMatch](../script/querymatch.md)> |**[queryMethodDefinition](#queryMethodDefinition)**(string scope, string methodName)|
||**[removeInclude](#removeInclude)**(string include)|
|int |**[selectBlockEnd](#selectBlockEnd)**()|
|int |**[selectBlockStart](#selectBlockStart)**()|
Expand Down Expand Up @@ -248,7 +248,7 @@ The returned QueryMatch instance will have the following captures available:
- `base` - The list of base classes/structs, if any
- `body` - The body of the class or struct definition (including curly-braces)
#### <a name="queryFunctionCall"></a>array<[QueryMatch](../script/querymatch.md)> **queryFunctionCall**(string functionName)
#### <a name="queryFunctionCall"></a>array&lt;[QueryMatch](../script/querymatch.md)> **queryFunctionCall**(string functionName)
Returns the list of function calls to the function `functionName`, no matter how many arguments they were called with.
Expand All @@ -259,7 +259,7 @@ The returned QueryMatch instances will have the following captures available:
- `argument-list` - The entire list of arguments, including the surroundg parentheses `()`
- `arguments` - Each argument provided to the function call, in order, excluding any comments
#### <a name="queryFunctionCall"></a>array<[QueryMatch](../script/querymatch.md)> **queryFunctionCall**(string functionName, array<string> argumentCaptures)
#### <a name="queryFunctionCall"></a>array&lt;[QueryMatch](../script/querymatch.md)> **queryFunctionCall**(string functionName, array&lt;string> argumentCaptures)
Returns the list of function calls to the function `functionName`.
Only calls that have the same number of arguments as `argumentCaptures` will be returned.
Expand All @@ -286,7 +286,7 @@ The returned QueryMatch instance will have the following captures available:
- `type`: The type of the member, without `const` or any reference/pointer specifiers (i.e. `&`/`*`)
- `name`: The name of the member (should be equal to memberName)
#### <a name="queryMethodDeclaration"></a>array<[QueryMatch](../script/querymatch.md)> **queryMethodDeclaration**(string className, string functionName)
#### <a name="queryMethodDeclaration"></a>array&lt;[QueryMatch](../script/querymatch.md)> **queryMethodDeclaration**(string className, string functionName)
Finds the declaration of a method inside a class or struct definition.
Expand All @@ -299,7 +299,7 @@ The returned QueryMatch instances contain the following captures:
- `function`: The function declaration, without the return type
- `name`: The name of the function
#### <a name="queryMethodDefinition"></a>array<[QueryMatch](../script/querymatch.md)> **queryMethodDefinition**(string scope, string methodName)
#### <a name="queryMethodDefinition"></a>array&lt;[QueryMatch](../script/querymatch.md)> **queryMethodDefinition**(string scope, string methodName)
Returns the list of methods definitions matching the given name and scope.
`scope` may be either a class name, a namespace or empty.
Expand Down
4 changes: 2 additions & 2 deletions docs/API/script/dir.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import Script
|[QDirValueType](../script/qdirvaluetype.md) |**[home](#home)**()|
|bool |**[isAbsolutePath](#isAbsolutePath)**(string path)|
|bool |**[isRelativePath](#isRelativePath)**(string path)|
|bool |**[match](#match)**(array<string> filters, string fileName)|
|bool |**[match](#match)**(array&lt;string> filters, string fileName)|
|bool |**[match](#match)**(string filter, string fileName)|
|[QDirValueType](../script/qdirvaluetype.md) |**[root](#root)**()|
|[QDirValueType](../script/qdirvaluetype.md) |**[temp](#temp)**()|
Expand Down Expand Up @@ -72,7 +72,7 @@ documentation.

#### <a name="isRelativePath"></a>bool **isRelativePath**(string path)

#### <a name="match"></a>bool **match**(array<string> filters, string fileName)<br/>bool **match**(string filter, string fileName)
#### <a name="match"></a>bool **match**(array&lt;string> filters, string fileName)<br/>bool **match**(string filter, string fileName)

#### <a name="root"></a>[QDirValueType](../script/qdirvaluetype.md) **root**()

Expand Down
8 changes: 4 additions & 4 deletions docs/API/script/menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import Script

| | Name |
|-|-|
|array<string>|**[actionIds](#actionIds)**|
|array<[MenuItem](../script/menuitem.md)>|**[children](#children)**|
|array&lt;string>|**[actionIds](#actionIds)**|
|array&lt;[MenuItem](../script/menuitem.md)>|**[children](#children)**|
|string|**[id](#id)**|

## Methods
Expand All @@ -22,11 +22,11 @@ import Script

## Property Documentation

#### <a name="actionIds"></a>array<string> **actionIds**
#### <a name="actionIds"></a>array&lt;string> **actionIds**

This property holds all action ids used in the menu.

#### <a name="children"></a>array<[MenuItem](../script/menuitem.md)> **children**
#### <a name="children"></a>array&lt;[MenuItem](../script/menuitem.md)> **children**

This property holds the list of menu items inside the menu.

Expand Down
4 changes: 2 additions & 2 deletions docs/API/script/menuitem.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Script

| | Name |
|-|-|
|array<[MenuItem](../script/menuitem.md)>|**[children](#children)**|
|array&lt;[MenuItem](../script/menuitem.md)>|**[children](#children)**|
|string|**[id](#id)**|
|bool|**[isAction](#isAction)**|
|bool|**[isSeparator](#isSeparator)**|
Expand All @@ -19,7 +19,7 @@ import Script

## Property Documentation

#### <a name="children"></a>array<[MenuItem](../script/menuitem.md)> **children**
#### <a name="children"></a>array&lt;[MenuItem](../script/menuitem.md)> **children**

This property holds the children of the menu item, in case this one is another level of menu.

Expand Down
16 changes: 8 additions & 8 deletions docs/API/script/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ import Script
| | Name |
|-|-|
|string|**[currentDocument](#currentDocument)**|
|array<string>|**[documents](#documents)**|
|array&lt;string>|**[documents](#documents)**|
|string|**[root](#root)**|

## Methods

| | Name |
|-|-|
|array<string> |**[allFiles](#allFiles)**(PathType type = RelativeToRoot)|
|array<string> |**[allFilesWithExtension](#allFilesWithExtension)**(string extension, PathType type = RelativeToRoot)|
|array<string> |**[allFilesWithExtensions](#allFilesWithExtensions)**(array<string> extensions, PathType type = RelativeToRoot)|
|array&lt;string> |**[allFiles](#allFiles)**(PathType type = RelativeToRoot)|
|array&lt;string> |**[allFilesWithExtension](#allFilesWithExtension)**(string extension, PathType type = RelativeToRoot)|
|array&lt;string> |**[allFilesWithExtensions](#allFilesWithExtensions)**(array&lt;string> extensions, PathType type = RelativeToRoot)|
||**[closeAll](#closeAll)**()|
|[Document](../script/document.md) |**[get](#get)**(string fileName)|
|[Document](../script/document.md) |**[open](#open)**(string fileName)|
Expand All @@ -37,7 +37,7 @@ The `Project` object is not meant to open multiple projects, but only open one.

Current document opened in the project.

#### <a name="documents"></a>array<string> **documents**
#### <a name="documents"></a>array&lt;string> **documents**

Return all documents opened in the project.

Expand All @@ -47,23 +47,23 @@ Current root path of the project, this can be set only once.

## Method Documentation

#### <a name="allFiles"></a>array<string> **allFiles**(PathType type = RelativeToRoot)
#### <a name="allFiles"></a>array&lt;string> **allFiles**(PathType type = RelativeToRoot)

Returns all files in the current project.
`type` defines the type of path, and can be one of those values:

- `Project.FullPath`
- `Project.RelativeToRoot`

#### <a name="allFilesWithExtension"></a>array<string> **allFilesWithExtension**(string extension, PathType type = RelativeToRoot)
#### <a name="allFilesWithExtension"></a>array&lt;string> **allFilesWithExtension**(string extension, PathType type = RelativeToRoot)

Returns all files with the `extension` given in the current project.
`type` defines the type of path, and can be one of those values:

- `Project.FullPath`
- `Project.RelativeToRoot`

#### <a name="allFilesWithExtensions"></a>array<string> **allFilesWithExtensions**(array<string> extensions, PathType type = RelativeToRoot)
#### <a name="allFilesWithExtensions"></a>array&lt;string> **allFilesWithExtensions**(array&lt;string> extensions, PathType type = RelativeToRoot)

Returns all files with an extension from `extensions` in the current project.
`type` defines the type of path, and can be one of those values:
Expand Down
8 changes: 4 additions & 4 deletions docs/API/script/qdirvaluetype.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ import Script
|string |**[at](#at)**(int pos)|
|bool |**[cd](#cd)**(string dirName)|
|bool |**[cdUp](#cdUp)**()|
|array<string> |**[entryList](#entryList)**(int filters, int sort)|
|array<string> |**[entryList](#entryList)**(string nameFilter, int filters, int sort)|
|array<string> |**[entryList](#entryList)**(array<string> nameFilters, int filters, int sort)|
|array&lt;string> |**[entryList](#entryList)**(int filters, int sort)|
|array&lt;string> |**[entryList](#entryList)**(string nameFilter, int filters, int sort)|
|array&lt;string> |**[entryList](#entryList)**(array&lt;string> nameFilters, int filters, int sort)|
|bool |**[fileExists](#fileExists)**(string name)|
|bool |**[makeAbsolute](#makeAbsolute)**()|
|bool |**[mkdir](#mkdir)**(string dirName)|
Expand Down Expand Up @@ -76,7 +76,7 @@ documentation. It can only be created using [Dir](dir.md) singleton.

#### <a name="cdUp"></a>bool **cdUp**()

#### <a name="entryList"></a>array<string> **entryList**(int filters, int sort)<br/>array<string> **entryList**(string nameFilter, int filters, int sort)<br/>array<string> **entryList**(array<string> nameFilters, int filters, int sort)
#### <a name="entryList"></a>array&lt;string> **entryList**(int filters, int sort)<br/>array&lt;string> **entryList**(string nameFilter, int filters, int sort)<br/>array&lt;string> **entryList**(array&lt;string> nameFilters, int filters, int sort)

`filters` is a combination of (default is `Dir.NoFilter`):

Expand Down
4 changes: 2 additions & 2 deletions docs/API/script/qttsdocument.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import Script
| | Name |
|-|-|
|string|**[language](#language)**|
|array<QtUiMessage>|**[messages](#messages)**|
|array&lt;QtUiMessage>|**[messages](#messages)**|
|string|**[sourceLanguage](#sourceLanguage)**|

## Methods
Expand All @@ -28,7 +28,7 @@ import Script

Return language name.

#### <a name="messages"></a>array<QtUiMessage> **messages**
#### <a name="messages"></a>array&lt;QtUiMessage> **messages**

List of all translations in the ts file.

Expand Down
4 changes: 2 additions & 2 deletions docs/API/script/qtuidocument.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Script

| | Name |
|-|-|
|array<[QtUiWidget](../script/qtuiwidget.md)>|**[widgets](#widgets)**|
|array&lt;[QtUiWidget](../script/qtuiwidget.md)>|**[widgets](#widgets)**|

## Methods

Expand All @@ -23,7 +23,7 @@ import Script

## Property Documentation

#### <a name="widgets"></a>array<[QtUiWidget](../script/qtuiwidget.md)> **widgets**
#### <a name="widgets"></a>array&lt;[QtUiWidget](../script/qtuiwidget.md)> **widgets**

List of all widgets in the ui file.

Expand Down
8 changes: 4 additions & 4 deletions docs/API/script/querymatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Script

| | Name |
|-|-|
|array<[QueryCapture](../script/querycapture.md)>|**[captures](#captures)**|
|array&lt;[QueryCapture](../script/querycapture.md)>|**[captures](#captures)**|
|bool|**[isEmpty](#isEmpty)**|

## Methods
Expand All @@ -22,7 +22,7 @@ import Script
|vector<[RangeMark](../script/rangemark.md)> |**[getAllInRange](#getAllInRange)**(string name, [RangeMark](../script/rangemark.md) range)|
|[RangeMark](../script/rangemark.md) |**[getAllJoined](#getAllJoined)**(string name)|
|[RangeMark](../script/rangemark.md) |**[getInRange](#getInRange)**(string name, [RangeMark](../script/rangemark.md) range)|
|array<[QueryMatch](../script/querymatch.md)> |**[queryIn](#queryIn)**(capture, query)|
|array&lt;[QueryMatch](../script/querymatch.md)> |**[queryIn](#queryIn)**(capture, query)|

## Detailed Description

Expand All @@ -47,7 +47,7 @@ https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Dest

## Property Documentation

#### <a name="captures"></a>array<[QueryCapture](../script/querycapture.md)> **captures**
#### <a name="captures"></a>array&lt;[QueryCapture](../script/querycapture.md)> **captures**

List of all the captures in the current document.

Expand Down Expand Up @@ -95,7 +95,7 @@ Returns a smallest range that contains all captures for the given `name`.

Returns the range covered by the first capture with the given `name` in the given `range`.

#### <a name="queryIn"></a>array<[QueryMatch](../script/querymatch.md)> **queryIn**(capture, query)
#### <a name="queryIn"></a>array&lt;[QueryMatch](../script/querymatch.md)> **queryIn**(capture, query)

Executes the treesitter `query` on all nodes that were captured under the `capture` name.

Expand Down
Loading

0 comments on commit 5c839b1

Please sign in to comment.