- ago
Some Extensions add new classes or extension methods of existing classes that are useful in a C# Coded Strategy.

I think it would be helpful to have documentation of these methods available in WL's C# Coding QickRef.

Is there a possibility (for extension developers) to add such information to the QuickRef?
0
248
8 Replies

Reply

Bookmark

Sort
- ago
#1
No, the [principal part of the] QuickRef isn't meant to be user extensible and is managed by the team. What kind of [external] classes would you like to have documented?
0
Glitch8
 ( 10.13% )
- ago
#2
Yes extensions can add files to the QuickRef.
0
- ago
#3
QUOTE:
Yes extensions can add


How?
0
Glitch8
 ( 10.13% )
- ago
#4
You can create a Markdown (md) file for each class you want to document. Then they should be installed into the WL8 app directory QuickRef folder.

Adding extension methods to existing classes is not supported in the QuickRef.
1
- ago
#5
Example Markdown syntax:

QUOTE:
# MyClass
Ancestor=Object
Namespace=finantic.SuperCoolExtension
Some important new class.

## Members
### Number
```csharp
public double Number
```
Returns a *number*.
0
- ago
#6
When I copy your example to QuickRef\MyClass.md (and add a few spaces) this works nicely.

My classes are named "Plot" and "PlotHost" however, so I tried a file named Plot.md with this content:

CODE:
# Plot Ancestor=Object Namespace=finantic.SuperCoolExtension Some important new class. ## Members ### Number ```csharp public double Number ``` Returns a *number*.

The Quickref shows:


What is the magic here?
0
Glitch8
 ( 10.13% )
- ago
#7
If I put your file in my QuickRef folder WL8 handles it perfectly.

0
- ago
#8
Solved.

I had files "Plot.md-unused" from former trials. Obviously the QuickRef system reads such files despite the unknown extension and "prefers" them when a word is clicked in code.

1

Reply

Bookmark

Sort