Difference between revisions of "OpenEMR API"

From OpenEMR Project Wiki
Line 7: Line 7:


*A related github repo can be found here: http://github.com/kevmccor/code-doc-oemr
*A related github repo can be found here: http://github.com/kevmccor/code-doc-oemr
*Directories to ignore (reason):
:*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

Revision as of 05:25, 19 June 2012

This is a project that was recently started to auto-document OpenEMR codebase.
  • (Was completed with phpDocumentor using following command on ubuntu: sudo phpdoc -t apidocs -o HTML:default:default -d . --ignore apidocs/,gacl/,phpmyadmin/,library/adodb/)
  • Directories to ignore (reason):
  • 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