fix: stream line the docs format for parsing and generating lua meta files

[lolrobbe2]

Before opening a new bug report, please read Reporting Bugs and consider if this is something you can contribute yourself. If this a new bug, help us help you by filling in the template below.

What seems to be the problem?
curently the documentation format is not fully standerdised, wich makes parsing the docs to generate lua meta files hard, and in some cases impossible.

What have you tried so far?
trying to work arround this by adding the different formats

the hard parts currently are, reliably aquiring the parameter type and parameter description in certain cases.
example: vsprops

preferably the type of the parameter is part of the description:

example:

• path string - is the relative path to be converted. It does not need to actually exist on the file system.
• file_list string[] - specifies one or more file patterns.

@KyrietS, @nickclark2016, any suggestion for a standardised format?

(You can now support Premake on our OpenCollective. Your contributions help us spend more time responding to issues like these!)

[KyrietS]

A few years ago half of the documentation was actually generated from code. There are still some pages with boilerplate that need some love. See conformancemode as an example. Not to mention that there are functions that exist in the code but do not have any mention in the docs.

So I'm not sure if you are supposed to parse our docs in order to get some metadata. Shouldn't you get this metadata from the code itself? We can't just guarantee that each page will always be parse-able with a generator that you write. It's just a Markdown. We try to follow similar style across multiple entries in our docs but I'm afraid it will never be a standardized database you want it to be.