Please add namespaces into API documentation and hyperlinks to types in declaration snippets
Please add namespaces into API documentation and hyperlinks to types in declaration snippets
04 Feb 2014, 21:59
Please add namespace to the automatically generated pages of cAlgo API. Having a namespace will help to navigate within the API. Adding cross reference hyperlinks in declaration of classes interfaces and other public members would also be helpful,
For example there is a Symbol symbol (pun intended). It is a interface, a property of a Robot or an Indicator.
Consider the following snippet.
Syntax
protected Symbol Symbol{ get; }
The snippet above is taken from API docs. In this snippet, the first occurrence of Symbol could be a hyperlink to Symbol interface.
And the pages for classes and other types could have included a namespace where the symbol resides, like below.
Summary
Base class for Indicators.
Namespace
cAlgo.API
Remarks
Contains all necessary market information, provides access to built-in indicators and provides framework for convenient indicators' creation.
Syntax
public class Indicator : Algo, IIndicator
Spotware
05 Feb 2014, 11:10
Thank you for your feedback. We will consider this suggestion.
@Spotware