xapian-bindings/python/extracomments.i

   1 %{
   2 /* python/extracomments.i: Custom written documentation comments.
   3  *
   4  * Copyright (C) 2007 Lemur Consulting Ltd
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
  19  * USA
  20  */
  21 %}
  22
  23 /* Override any incorrect, missing or unhelpful documentation comments here. */
  24
  25 %feature("docstring") Xapian::MSet::get_hit "Get an item from the MSet.
  26
  27 The supplied index is relative to the start of the MSet, not the absolute rank
  28 of the item. ";