cakephp / api_generator

[Unmaintained] Official CakePHP API Generator Git Repository
113 stars 31 forks source link

Empty API pages #25

Open ghost opened 11 years ago

ghost commented 11 years ago

Created by Marc Würth, 2nd Feb 2013. (originally Lighthouse ticket #112):


Files like /Cake/Console/Templates/skel/Config/core.php contain quite some amount of useful comments about possible configurations. I know there is a cookbook page about these config settings at http://book.cakephp.org/2.0/en/development/configuration.html#cakephp-core-configuration, which is more (or rather less) a duplication of the comments in core.php. But why are files like these (http://api.cakephp.org/file/Cake/Console/Templates/skel/Config/core.php) in the API docs totally blank? I know these files aren't really part of the API as they aren't classes. I'd love to be able to search for those comments in the API docs nonetheless. But if tthey aren't meant to be shown in the online api docs then I think being able to navigate through them is kind of obsolete...

As it seems you currently aren't really happy about the state of the docs (http://cakephp.lighthouseapp.com/projects/42879/tickets/111-some-api-pages-return-404). So I guess this is more like an improvement for the future than something that has to be fixed...