Suggestions
Hi @theseer ,
Thanks for your work. I would like to give a few suggestion, not sure anyone / you have already thought of these.
Some suggestion looking at the demo are
- There is no way to get to parent namespace . Eg : http://phpdox.de/demo/ZendFramework2/classes/Zend_Http_AbstractMessage.xhtml#getVersion
- Good to have search capability
- View the code when clicked on the method again.
Thank you for all the work.
Hi @harikt,
Thank you for those suggestions! It's always helpful to get feedback and ideas from people who use my software :-)
Let me address each of your points:
- Parent Namespace: This issue might already have been solved by the new(er) template design. I'm about to release Version 0.7 of phpDox and will refresh the demo output based on its output.
- Search I'm aware of the fact a search is missing. Currently though, as the docs are generated and after that static html i'm not exactly sure what would be the best technical approach to implement it. Until I have a clear concept, this feature has to remain on the todo list. If you have any points for an open source JavaScript based search implementation, i'd be happy to have a look at them.
- Source view phpDox 0.7 has highlighted source view implemented. It will get way more into that view as well but at least it's already there.
For future ideas of enhancement: It would make tracking the individual request a lot easier if you'd open individual tickets for each. That way for example I could have closed the source code view idea as already implemented while leaving the search open for discussion.
Thank you for your input!
- Parent Namespace: Great! :+1:
- Search : I am not sure how to do. But I will see if I can find how apigen is using . Eg : http://apigen.juzna.cz/doc/zendframework/zf2/
- Source view : Nice.
Sure, next time I will.
Thank you.
They use google custom search via ajax calls. This is not exactly a nice solution as it is not self contained, requires signup with google and is not free (if you do more than 100 searches a day)
ok. Thanks for the information. Wonder now how Sami is doing though.
Hm. @theseer I wonder which searched you looked. I have the api's generated with apigen in local and it is not using any internet connectivity to do the search.
I just checked at the URL you referred to in the previous comment. When clicking the search button on top, an ajax call to google is performed.
Okay, small update: The autosuggest of apigen works by merely looking up the search string in a list of entries which is stored as a JavaScript Array.