API Squirrel DOC

[victor_18993]

Hello, I've attached the API documentation in German, Spanish, and English, which includes the functions already exposed by the engine, examples, and their return values to facilitate the use of Squirrel. I hope this helps.

Best regards.

https://files.simutrans-germany.com/upload/PDF_API.zip

[prissi]

Are those from the doxygen script from the code? The squirrel code is already full dixygen augemented?

[victor_18993]

Hi Prisi, partly.
Simutrans already has a dedicated Doxygen setup for the Squirrel API (

Code Select Expand

documentation/DoxyfileSQAPI.in), and I used the existing Doxygen/source comments as one of the sources.

However, this package is not simply the raw Doxygen output. I generated it by cross-checking the API actually exposed by the engine, the bindings, existing Doxygen/source documentation, runtime information and the available examples/tests. That is also where the examples and return-value information come from.

And no, the Squirrel/API code is not completely documented with Doxygen yet. While preparing this I found a number of places where documentation is incomplete or inconsistent. One of the goals of this work is precisely to identify those gaps so we can improve the canonical API documentation gradually.

[makie]

https://files.simutrans-germany.com/upload/API_Squirrel.zip

But there's nothing in there except an index.html file.

[victor_18993]

Sorry, I already uploaded the PDFs and changed the path,

cheers.


https://files.simutrans-germany.com/upload/PDF_API.zip