Restructured Lua File, Added spray and shape brush, Added extensive HELP text

gynt / stronghold-mapeditortools

Map Editor Tool Set for Stronghold and Stronghold Crusader

GNU Affero General Public License v3.0

6 stars 1 forks source link

Restructured Lua File, Added spray and shape brush, Added extensive HELP text #3

Closed TheRedDaemon closed 3 years ago

TheRedDaemon commented 3 years ago

The issue of the shape-brush easily exceeding the action limit is of course still there.
The auto generated command list still does not contain "help", so I added it via HELP. 😉

TheRedDaemon commented 3 years ago

Just a question outside the remarks: The @author statements... should I add them only to the functions I mainly wrote, or to the comments in general? Or is there a comment convention you would prefer? A general form basically? (Currently I am switching between (--) and (--[[ ]]--) comments quite liberally for example. That does not really feel right.)

gynt commented 3 years ago

Oh I was mainly talking about the functions you wrote. But it makes more sense that you add author to the comments that are about future ideas or potential issues!

TheRedDaemon commented 3 years ago

Ok, added the requested stuff, including (at)author statements. (@author links to some github project... good name for traffic 😄 ) I would say, comments inside a function are assumed to be from the function author if not stated otherwise. Ready for next review.