From b1a9e58ad6dc3885e4f2545a893fa9876a109a9b Mon Sep 17 00:00:00 2001
From: Tobias Schmidt <tobias.schmidt@unibas.ch>
Date: Thu, 28 Jun 2012 12:55:53 +0200
Subject: [PATCH] add documentation for connect function
---
modules/mol/base/doc/editors.rst | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/modules/mol/base/doc/editors.rst b/modules/mol/base/doc/editors.rst
index ad4d7fb07..8ef488da3 100644
--- a/modules/mol/base/doc/editors.rst
+++ b/modules/mol/base/doc/editors.rst
@@ -213,6 +213,23 @@ The basic functionality of editors is implemented in the EditorBase class.
valid atom identifier.
:type new_name: string
+ .. method:: Connect(atom1, atom2)
+ Connect(atom1, atom2, bond_order)
+
+ Add a bond between two atoms.
+
+ :param atom1: Must be a valid atom
+ :type atom1: :class:`AtomHandle`
+ :param atom2: Must be a valid atom
+ :type atom2: :class:`AtomHandle`
+ :param bond_order: bond order (e.g. 1=single, 2=double, 3=triple)
+ :type bond_order: :class:`int`
+
+BondHandle (EditorBase::*connect_b)(const AtomHandle&, const AtomHandle&,
+ Real, Real, Real)=&EditorBase::Connect;
+BondHandle (EditorBase::*connect_d)(const AtomHandle&, const AtomHandle&,
+ Real, Real, Real,
+ unsigned char)=&EditorBase::Connect;
Editor for the External Coordinate System
--------------------------------------------------------------------------------
--
GitLab