Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Full Docs for Gitonomy\Git #164

Open
phpfui opened this issue Feb 7, 2020 · 0 comments
Open

Full Docs for Gitonomy\Git #164

phpfui opened this issue Feb 7, 2020 · 0 comments

Comments

@phpfui
Copy link
Contributor

phpfui commented Feb 7, 2020

This is not an issue, but rather a comment.

Thought everyone would like to see the full PHP doc blocks for Gitonomy\Git. I wrote a library to easily document PHP libraries via the doc blocks. You can check it out here: http://www.phpfui.com/?n=Gitonomy%5CGit

Basically it uses the Reflection classes to grab everything, then displays it in real time for each class. What that means is documentation is rendered on the fly for files on the machine it is running on, which in the case of your local dev machine, it will render what you are currently working on.

It also displays the syntax highlighted PHP source, and since it uses the Gitonomy library, it will show you the commit history of files in the local repo. In the case of http://www.phpfui.com, I store all libraries in the repo for the site (best practice actually, as you can see what changes for each version, which can avoid issues like https://www.zdnet.com/article/hacker-backdoors-popular-javascript-library-to-steal-bitcoin-funds/), so you won't see the commits to this repo, only mine and any updates since my initial commit. But take a look at PHPFUI\Instadoc\Section\Doc for a more complete look at the local repo.

I still have to add the ability to specify the MD docs you have in the docs directory, so look for that in the coming weeks.

So many thanks to everyone who supports this library. Very useful to be able to get git information in PHP!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant