diff Plugins/OrthancCPlugin/OrthancCPlugin.h @ 906:cbc0ea03dffe plugins

sample plugin configuration
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 19 Jun 2014 13:37:49 +0200
parents 2732b5f57d9c
children 9b8298234254
line wrap: on
line diff
--- a/Plugins/OrthancCPlugin/OrthancCPlugin.h	Thu Jun 19 11:40:05 2014 +0200
+++ b/Plugins/OrthancCPlugin/OrthancCPlugin.h	Thu Jun 19 13:37:49 2014 +0200
@@ -1,3 +1,20 @@
+/**
+ * \mainpage
+ *
+ * This SDK allows external developers to create plugins that can be
+ * loaded into Orthanc to extend its functionality. Each Orthanc
+ * plugin must expose 4 public functions with the following
+ * signatures:
+ * 
+ * - <tt>int32_t OrthancPluginInitialize(const OrthancPluginContext*)</tt>:
+ *   This function is invoked by Orthanc
+ * - <tt>void OrthancPluginFinalize()</tt>
+ * - <tt>const char* OrthancPluginGetName()</tt>
+ * - <tt>const char* OrthancPluginGetVersion()</tt>
+ **/
+
+
+
 /**
  * @defgroup CInterface C Interface 
  * @brief The C interface to create Orthanc plugins.
@@ -6,6 +23,7 @@
  **/
 
 
+
 /**
  * Orthanc - A Lightweight, RESTful DICOM Store
  * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege,
@@ -38,6 +56,7 @@
  **/
 
 
+
 #pragma once
 
 
@@ -362,16 +381,6 @@
   }
 
 
-  /**
-     Each plugin must define 4 functions, whose signature are:
-     - int32_t OrthancPluginInitialize(const OrthancPluginContext*);
-     - void OrthancPluginFinalize();
-     - const char* OrthancPluginGetName();
-     - const char* OrthancPluginGetVersion();
-
-     nm -C -D --defined-only libPluginTest.so
-  **/
-
 #ifdef  __cplusplus
 }
 #endif