Documentation of v3

[michaeluno]

There are methods that changed their behavior entirely and their documentation has not been updated yet as well as the newly introduced classes.

[michaeluno]

I was using phpDocumentor2 for the inline documentation parser. But it does not generate docBlocks of extended classes and there are some other bugs so I'm going to switch to ApiGen.

ApiGen has slightly different specifications from phpDocumento2 including the format of packages and sub packages and parameters etc. So it takes some time for me to convert all of them to the new syntax.

I'm going to include the documentation pages in the demo plugin. The problem is that the size of the documentation folder will be about 1.72MB, which will add the size to the distribution package.

I expect the users will just use the minified version whose size is currently less than 300kb so it should not be a serious problem. However, some may misunderstand the library is too huge to include in their project by just glancing at the size of the distributed one.

If anybody has an opinion about this, let me know. Also if anybody is interested in how it looks, here is the branch so grab it. https://github.com/michaeluno/admin-page-framework/tree/v3/documentation

[michaeluno]

It seems including the documentation files in the distribution package has not done any harm so far. So I'm going to close this topic.