-
Notifications
You must be signed in to change notification settings - Fork 149
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Wiki documentation #564
Comments
What else do you need though? The function headers are very descriptive. |
Indeed they are but they are not linked anywhere other than Ace3 guides it seems. Finding them and even realizing such functions exist is an issue. Sorry for not being more precise. |
The functions page is generated from function headers in CBA, the wiki is written manually |
Well I do not know how its done or by who, but the point is that those functions linked from the ace wiki are not on the online reference page. |
It's been a while since I updated the function reference (last link above) - I'll get to it as soon as possible. Am away from home for a while, but hopefully this upcoming weekend. EDIT: online function reference has been updated to be in sync with CBA 3.1.2. For example: CBA_fnc_waitAndExecute (The circular reference loop between the wiki and function reference though, that needs improvement) |
Just to add to this. On the home page of the wiki here it displays...
It seems maybe someone was trying to use markdown and link other pages. |
https://github.com/CBATeam/CBA_A3/wiki/Custom-Events-System#parameter-data-type-limitations add and/or reference |
Links to to the documentation of these two functions are only found in code section of github:
http://ace3mod.com/wiki/development/arma-3-scheduler-and-our-practices.html#waitandexecute
http://ace3mod.com/wiki/development/arma-3-scheduler-and-our-practices.html#waituntilandexecute
There were others but I will link them once I find them.
This page:
https://github.com/CBATeam/CBA_A3/wiki/Function%20and%20Macro%20Libraries
And this page:
http://cbateam.github.io/CBA_A3/docs/files/overview-txt.html
They just link to eachother via
"See Functions and Macros reference"
"Function and Macro Libraries"
I am really glad that CBA is actively taken care of and updated, but it seems the documentation is lagging behind development in the wiki and the reference page. Do you guys have any plans to switch to maintaining only the wikipage or are you planing on keeping both going?
The text was updated successfully, but these errors were encountered: