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.

Sign up for GitHub

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

Jump to bottom

API Documentation - http://api.getcomposer.org #1163

Closed
RobLoach opened this issue Oct 1, 2012 · 5 comments
Closed

API Documentation - http://api.getcomposer.org #1163

RobLoach opened this issue Oct 1, 2012 · 5 comments

Comments

@RobLoach
Copy link
Contributor

RobLoach commented Oct 1, 2012

Would be nice to have Sami-powered documentation on http://api.getcomposer.org:
https://github.com/RobLoach/api.getcomposer.org

Here's a screenshot:
http://i.imgur.com/1DlWr.png
@fprochazka
Copy link
Contributor

I'd rather suggest using Apigen http://apigen.org/ There is a great service, you can use to test it http://apigen.juzna.cz/

The example api documentation can be already viewed at http://apigen.juzna.cz/doc/composer/composer/

@Seldaek
Copy link
Member

Seldaek commented Oct 1, 2012

Is this really any use vs browsing the code with a proper editor/IDE? I can't remember last time I used api docs for the project I'm currently working on (i.e. have the sources readily available for).

@GromNaN
Copy link
Contributor

GromNaN commented Oct 1, 2012

@Seldaek When developing a custom script/installer using the phar, we don't necessarily have access to the composer source code.

@Seldaek
Copy link
Member

Seldaek commented Oct 1, 2012

I'd still prefer to clone the source than to check out online APIs but fair enough.

Seldaek added a commit to composer/getcomposer.org that referenced this issue Oct 1, 2012
@Seldaek
Add api docs, fixes composer/composer#1163
198b14c
@Seldaek
Copy link
Member

Seldaek commented Oct 1, 2012

Done, see http://getcomposer.org/doc/ (bottom)

@Seldaek Seldaek closed this as completed Oct 1, 2012
igorw added a commit to igorw/getcomposer.org that referenced this issue Oct 24, 2012
@igorw
Merge remote-tracking branch 'upstream/master' into make-pdf
2cd4525 
* upstream/master:
  Tweak messages a bit
  Fix padding on small widths
  Fix padding on .fork-and-edit icon
  Add windows installer instructions
  Oops
  Fix ionCube Loader check
  Fix installer for PHP 5.2
  Fix scripts to be quiet
  Add api docs, fixes composer/composer#1163
  Only warn for ioncube <4.0.9, fixes composer/composer#395
  Fixes variable names, only displays once
  Updates installer error messages to include PHP.INI path.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@RobLoach @fprochazka @Seldaek @GromNaN