RME icon indicating copy to clipboard operation
RME copied to clipboard

[RME] Serialization of commands' documentation

Open acs-l opened this issue 8 years ago • 2 comments

Definition of commands' documentation as used by Forge (or any other documentation parser)

Structures' contract which defines what should be produce by RME in order to be consumed by Forge.

acs-l avatar Feb 12 '18 20:02 acs-l

Why "by forge" ? Forge is a package manager

xvw avatar Feb 13 '18 06:02 xvw

Summing-up what has been privately discussed with @xvw:

  • Commands can be nested only in one sub-level (which will furtherly be denoted as sections) under RME::Command. It actually means the following:
    • Authorized: {RME::Command::Event, RME::Command::Map, RME::Command::Camera...}
    • Unauthorized: RME::Command::Event::Movement
  • Documentation will be generated as follow:
    • {{section_name}}.json: section's description and the list of commands declared under it
    • {{section_name}}/{{command_name}}.json: directory which contains the commands nested under the section (one .json file per command)

acs-l avatar Feb 28 '18 16:02 acs-l