search

Atherys / AtherysQuests

A questing plugin for the A'therys Horizons server
GNU General Public License v3.0
3 stars 2 forks source link

Uncertainty regarding arrays as parameters. #39

Closed raxiam closed 5 years ago

raxiam commented 5 years ago

Problem: In the signature of functions, parameters that are arrays are written in plural form as opposed to singular, making them sometimes go unnoticed.

Proposed Solution: Denote arrays with [] for the parameter name.

Ex: Boolean addQuestRewards(Quest quest, Reward [rewards])

HaedHutner commented 5 years ago

Rather a more correct example would be

Boolean addQuestRewards(Quest quest, Reward[] rewards)

@LJNIC Since you're the docs guy, I'm assigning this to you

raxiam commented 5 years ago

Yeah, go with heads example.

LJNIC commented 5 years ago

This is fixed in the latest commits to the AtherysDoclet. I'm not sure where future issues with documentation should go. The documentation is mostly written in the code itself, but generated by the previously mentioned Doclet, and then pushed to AtherysDocs.