charliez Posted March 24, 2012 Share Posted March 24, 2012 Playing with stuff I wanted to create API Docs for PW. On doing that, I stumbled on the ApiGen Generator project @ http://apigen.juzna.cz/ and went ahead and submitted PW. You can check the results @ http://apigen.juzna.cz/doc/ryancramerdesign/ProcessWire/index.html Enjoy! 2 Link to comment Share on other sites More sharing options...
Pete Posted March 24, 2012 Share Posted March 24, 2012 That's pretty neat Have you seen the cheatsheet though? Link to comment Share on other sites More sharing options...
charliez Posted March 24, 2012 Author Share Posted March 24, 2012 Yes I have. I even made a PDF version of it... but for example I do not want to Grep the code to find addHook for example... Link to comment Share on other sites More sharing options...
Adam Kiss Posted March 24, 2012 Share Posted March 24, 2012 It's nice, this really could be used on the side (as the extended cheatsheet version). I for instance like this generated documentation much more than tutorial-like written documentation, when I'm deep in the code doing something. Link to comment Share on other sites More sharing options...
ryan Posted March 25, 2012 Share Posted March 25, 2012 This looks very interesting--thanks for setting this up charliez! I do worry a little about documentation like this, because it steps outside of our public API. I don't consider every function in PW to be part of the public API that folks should use (the majority of it is not). ProcessWire isn't meant to be that low-level of a framework. There are so many components that are really just there to support the public API, rather than be part of it. Looking at the docs in this manner loses all context of that. The cheatsheet really has the right context. I would just suggest that people use our regular API docs (especially the cheatsheet) and then use something like this apigen documentation for zeroing in on more detail about a specific function or class, if they need it. I think the apigen documentation could really be useful for contextual links to more detailed function reference, where applicable (like in links from the cheatsheet). But I don't suggest integrating functions that aren't in the cheatsheet into your projects. The public API in ProcessWire is a constant, but everything else can change with versions. Also, I'm not so sure what I think about this service hosting our documentation (I don't know them well enough yet), so I went ahead and copied it to here: http://processwire.com/apigen/ 1 Link to comment Share on other sites More sharing options...
charliez Posted March 25, 2012 Author Share Posted March 25, 2012 I agree with you Ryan. Once I had the time to browse the API docs I came to the same conclusion. I think that your idea of linking the proper info to the cheatsheet would make for the best resource. And leave this API doc for more indepth study of PW, or for the discovery of more internal methods and functions when developing more advanced modules. Let me know if you prefer to have them removed from the Czech project and I will contact them to have it removed from their page... Link to comment Share on other sites More sharing options...
ryan Posted March 27, 2012 Share Posted March 27, 2012 No need to remove it Charliez. Hopefully some other people will see it there and decide they want to check out ProcessWire. I'm pretty impressed with apigen's results. Seems like a lot less hassle than the old PHPdoc. Link to comment Share on other sites More sharing options...
charliez Posted March 27, 2012 Author Share Posted March 27, 2012 OK. Yes I find it very nice to find and read/study the source. It even uses a nice highlighting for the code... As you mentioned, great complement to the cheatsheet! Link to comment Share on other sites More sharing options...
netcarver Posted March 27, 2012 Share Posted March 27, 2012 This might also help in identifying code that might be of api candidate status. Link to comment Share on other sites More sharing options...
Luglio7 Posted March 27, 2012 Share Posted March 27, 2012 You opened to me a new world Link to comment Share on other sites More sharing options...
Ivan Gretsky Posted May 31, 2014 Share Posted May 31, 2014 Seems like the main processwire site now uses that engine too: http://processwire.com/apigen/. Maybe old news, but i have not seen a link to that usefull resource anywhere. 1 Link to comment Share on other sites More sharing options...
kongondo Posted February 3, 2016 Share Posted February 3, 2016 I have started a project that fully automates the generation and regularly updating of ApiGen docs for all currently maintained ProcessWire branches...More info here 1 Link to comment Share on other sites More sharing options...
Recommended Posts
Create an account or sign in to comment
You need to be a member in order to leave a comment
Create an account
Sign up for a new account in our community. It's easy!
Register a new accountSign in
Already have an account? Sign in here.
Sign In Now