User talk:Mark Otaris/Final generation

Note: when I talk about "this page" here, I mean the page this talk page corresponds to, not the talk page itself.

Explanation:

The content of this page was generated automatically by an automated program I created that went through the API dump and automatically generated the basic documentation. The only thing the member sections in this page are missing is descriptions, because the automated program cannot write the descriptions.

Process:

To help, first, choose a class that you want to create a page on from the ones you can see in the table of contents of this page. Go to the page with the same name as the class and copy all that was in the class's section on this page. Write a description for the class (the description should explain what the class is). Then, add the class infobox to the page.

Then, for each member in the page, write a description for the member and give it to the template with the description parameter. If there are parameters or return values (indicated by the pt1, pn1 and rt1 arguments), add an argument named 'pd', suffixed with the same number as the number that suffixes the pt or rt argument, and write a description of the parameter in that argument. If it was done correctly, the description should appear in the third column of the table that describes the parameters or the return values.

Make sure to check in the API dump, using the CTRL+F key, for example, if the class is preliminary. If it is, set the status argument to 'preliminary'. If the class is also a structural class, set the status2 argument to 'uncreatable', unless you didn't use the status argument, in which case you should set that one to 'uncreatable'. If the class is a service, set one of the available status arguments (there are 3, status, status2 and status3) to 'service'. The arguments mentioned in this paragraph should be added to the infobox rather than the members, since they apply to the class.

All members that are just camelCase variants of other members should be ignored. Also, it may be desirable to exclude specific members or to not describe certain things, so use your brain when documenting.

If you didn't understand any of this (it's really not as easy to explain as you'd think), perhaps an example will help:

The  class can be used to create events that can be placed in the game hierarchy.

The statuses in the infobox in the previous example were added just to demonstrate how they should be added; the  class is not actually preliminary and is creatable.

Once you're done, remove the section about the class whose page you created from this page.