Feature #11009

Add missing informations to the wiki docs

Added by Rafalsky almost 5 years ago. Updated about 1 year ago.

Status:Closed Start date:06/05/2010
Priority:Normal Due date:
Assignee:Sickboy % Done:

100%

Category:Documentation
Target version:-
Component: Affected Version:
Close Reason:

Description

Adding missing informations to the wiki documentations would be very helpful. (parameters, examples etc)

bad eg: http://dev-heaven.net/docs/cba/files/common/fnc_createCenter-sqf.html


Related issues

related to Community Base Addons - Feature #24089: Added features to CBA_fnc_getMagazineVerified Closed 09/03/2011

Associated revisions

Revision ec2b512f
Added by Sickboy almost 5 years ago

Missing docs. fixes #11009

Revision ec2b512f
Added by Sickboy almost 5 years ago

Missing docs. fixes #11009

Revision 6fa8a8e1
Added by Sickboy almost 5 years ago

Updated CfgFunctions and Docs. refs #11009

Revision 6fa8a8e1
Added by Sickboy almost 5 years ago

Updated CfgFunctions and Docs. refs #11009

Revision 9a782a0d
Added by killswitch almost 4 years ago

~FIXED: added docs for CBA_fnc_AddMagazineVerified. Refs #11009.

Revision 9a782a0d
Added by killswitch almost 4 years ago

~FIXED: added docs for CBA_fnc_AddMagazineVerified. Refs #11009.

Revision 373ec0f2
Added by killswitch almost 4 years ago

~FIXED: added more function docs. Refs #11009.

Revision 373ec0f2
Added by killswitch almost 4 years ago

~FIXED: added more function docs. Refs #11009.

History

Updated by Sickboy almost 5 years ago

  • Status changed from New to Resolved
  • % Done changed from 0 to 100

Updated by Rafalsky almost 5 years ago

Generally all functions (with missing info) in the wiki docs needs update. Thank you in advance.

Updated by Sickboy almost 5 years ago

Rafalsky wrote:

Generally all functions (with missing info) in the wiki docs needs update. Thank you in advance.

Let me know which that are and I shall look into it.

Updated by Rafalsky almost 5 years ago

I was looking at many index-fnc-items and notice that many items do not have required info.
example of good info: http://dev-heaven.net/docs/cba/files/strings/fnc_find-sqf.html

example of bad info: http://dev-heaven.net/docs/cba/files/common/fnc_addMagazineVerified-sqf.html
(most of info is missing: no examples etc.)

For s/o who have many hours of experiences probably this is no problem, but for people like me, with very little experience in programming proper info: examples, syntax, parameters would be great help.
Something what is obvious for experts sometimes is big problem for inexperienced ones.

Updated by Sickboy almost 5 years ago

  • Status changed from Resolved to In progress
  • Assignee set to Sickboy
  • % Done changed from 100 to 60

Updated by Sickboy almost 5 years ago

Thanks a lot for the comprehensive reply :)
I'll run them down, hopefully with Rommel and add missing info.

Here are the sources of the addons btw: http://dev-heaven.net/projects/cca/repository/revisions/develop/show/addons
(Also included with the releases in the files section)

Hope they are helpful while we'll work out the docu.

Updated by Sickboy almost 2 years ago

  • Status changed from In progress to Resolved
  • % Done changed from 60 to 100

Updated by killswitch about 1 year ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF