From 6e3d90e2a4cd0a5b863748b88ab67e959f47f0f6 Mon Sep 17 00:00:00 2001
From: Aleksander Morgado <aleksander@lanedo.com>
Date: Wed, 11 Jul 2012 10:20:11 +0200
Subject: plugin: new `MM_PLUGIN_CUSTOM_INIT' property

We let plugins execute some custom initialization in the ports, specified by
a `MMAsyncMethod'.
---
 docs/reference/api/ModemManager-overview.xml | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'docs/reference/api')

diff --git a/docs/reference/api/ModemManager-overview.xml b/docs/reference/api/ModemManager-overview.xml
index 79147e13..ebb81585 100644
--- a/docs/reference/api/ModemManager-overview.xml
+++ b/docs/reference/api/ModemManager-overview.xml
@@ -175,6 +175,20 @@
           prepare the information required in any expected post-probing filter.
         </para>
         <itemizedlist>
+          <listitem>
+            <para><emphasis>Custom initialization</emphasis></para>
+            <para>
+              This property allows plugins to provide an asynchronous method which will get
+              executed as soon as the AT port gets opened. This method may be used for any
+              purpose, like running an early command in the ports as soon as possible, or
+              querying the modem for info about the port layout.
+            </para>
+            <para>
+              This configuration is specified by the <type>MM_PLUGIN_CUSTOM_INIT</type>
+              property in the <structname>MMPlugin</structname> object provided
+              by the plugin.
+            </para>
+          </listitem>
           <listitem>
             <para><emphasis>AT allowed</emphasis></para>
             <para>
-- 
cgit v1.2.3-70-g09d2