Difference between revisions of "OpenEMR API"

From OpenEMR Project Wiki
Line 1: Line 1:
== Overview ==
:This is a project that was recently started to auto-document OpenEMR codebase.
:This is a project that was recently started to auto-document OpenEMR codebase.


*Most recent run can be found here: http://www.open-emr.org/apidocs/
== API ==
*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/'')


== Plan ==
*Sourceforge forum on this topic can be found here: http://sourceforge.net/projects/openemr/forums/forum/202506/topic/5355691
*Sourceforge forum on this topic can be found here: http://sourceforge.net/projects/openemr/forums/forum/202506/topic/5355691



Revision as of 16:32, 20 June 2012

Overview

This is a project that was recently started to auto-document OpenEMR codebase.

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/)

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