OpenEMR API

Overview

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

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/ --defaultpackagename OpenEMR --title "OpenEMR API Documentation" --sourcecode)

• Next run:

• Try to fix following parameter: --sourcecode (considered an unstable option and doesn't appear to be working) to get it to link to the source code (or figure out another mechanism)
• Experiment with other template (such as HTML:frames:earthli)

Plan

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

• A related github repo can be found here: http://github.com/kevmccor/code-doc-oemr

• 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