Difference between revisions of "OpenEMR API"

From OpenEMR Project Wiki
Line 5: Line 5:
*Most recent API run can be found here: http://www.open-emr.org/apidocs/
*Most recent API run can be found here: http://www.open-emr.org/apidocs/
:*(Was completed with phpDocumentor using following command on ubuntu: ''sudo phpdoc -t apidocs -o HTML:default:default -d . --ignore apidocs/,gacl/,phpmyadmin/,library/adodb/,interface/main/calendar/pnadodb/'')
:*(Was completed with phpDocumentor using following command on ubuntu: ''sudo phpdoc -t apidocs -o HTML:default:default -d . --ignore apidocs/,gacl/,phpmyadmin/,library/adodb/,interface/main/calendar/pnadodb/'')
::*Next run, try ''--defaultpackagename OpenEMR'' parameter.
::*Next run, try following parameters:
:::*''--defaultpackagename OpenEMR''
:::*''--title OpenEMR API Documentation''
:::*''--sourcecode'' (considered an unstable option)


== Plan ==
== Plan ==

Revision as of 18:18, 20 June 2012

Overview

This is a project that was recently started to auto-document the OpenEMR codebase. The project is still in an early phase.

API

  • (Was completed with phpDocumentor using following command on ubuntu: sudo phpdoc -t apidocs -o HTML:default:default -d . --ignore apidocs/,gacl/,phpmyadmin/,library/adodb/,interface/main/calendar/pnadodb/)
  • Next run, try following parameters:
  • --defaultpackagename OpenEMR
  • --title OpenEMR API Documentation
  • --sourcecode (considered an unstable option)

Plan

  • Directories/Files to ignore:
  • apidocs/
  • Reason - This is the API docs directory
  • gacl/
  • Reason - This is an embedded module with an API already included. Additionally, connector functions can be found at library/acl.inc .
  • phpmyadmin/
  • Reason - This is an embedded application that does not communicate directly with OpenEMR.
  • library/adodb/
  • Reason - This is an embedded module and connector functions can be found at library/sql.inc
  • interface/main/calendar/pnadodb/
  • Reason - This is an embedded module and connector functions can be found at library/sql.inc