X-Sharp / XSharpPublic

Public repository for the source code for the XSharp Compiler, Runtime, Project System and Tools.
Apache License 2.0
93 stars 36 forks source link

[Documentation] Topic for DBOrderInfo() does not include available constants #1565

Open cpyrgas opened 4 hours ago

cpyrgas commented 4 hours ago

The documentation for DbInfo() includes the available DBI_ constants that can be used with it: https://www.xsharp.eu/runtimehelp/html/M_XSharp_RT_Functions_DbInfo.htm

But the documentation for DBOrderInfo() does not include any: https://www.xsharp.eu/runtimehelp/html/M_XSharp_RT_Functions_DbOrderInfo.htm

cpyrgas commented 3 hours ago

Robert,

Oh, I thought it would be easy for me to add this in the documentation, but it's not in the help file, I assume it's generated automatically.

I saw some related entries in the files \src\Docs\rdd.xml and \src\Docs\VoFunctionDocs.xml, do I need to add the info there as xml, or is there some visual way to do this?

RobertvanderHulst commented 2 hours ago

The docs for the runtime function are generated in 2 steps:

In fact: the code for DbInfo() is not optimal. The same table is included in the topic for DbServer.Info (but there it is better formatted) I will extract that table from DbInfo() and use the same table in both topics. I will do the same for DbOrderInfo() and DbRecordInfo

cpyrgas commented 1 hour ago

OK, sounds good!