From 6b4010b7718a53002a54e4355ebd45a9ffa7fa67 Mon Sep 17 00:00:00 2001 From: nicholas Date: Sun, 14 Jan 2007 20:29:38 +0000 Subject: Use gtkdoc documentation for python docstrings, topped up with docstrings by Todd Zullinger. git-svn-id: https://gtkpod.svn.sf.net/svnroot/gtkpod/libgpod/trunk@1366 f01d2545-417e-4e96-918e-98f8d0dbbcb6 --- bindings/python/gpod.i.in | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'bindings/python/gpod.i.in') diff --git a/bindings/python/gpod.i.in b/bindings/python/gpod.i.in index ef6e65a..a908e02 100644 --- a/bindings/python/gpod.i.in +++ b/bindings/python/gpod.i.in @@ -28,7 +28,17 @@ Please send any fixes, improvements or suggestions to */ -%module gpod +%define DOCSTRING +"This module gives access to an iPod's content. It provides an easy to +use API to retrieve the list of files and playlists stored on an iPod, +modify them, and save them back to the iPod. + +This module implements the libgpod C API as directly as possible in +Python. See the main gpod module for a more traditional Python +interface." +%enddef + +%module(docstring=DOCSTRING) gpod %{ #include "db-artwork-debug.h" #include "db-artwork-parser.h" @@ -163,6 +173,8 @@ PyObject* sw_get_playlists(Itdb_iTunesDB *itdb) { %} +%include "gpod_doc.i" + # be nicer to decode these utf8 strings into Unicode objects in the C # layer. Here we are leaving it to the Python side, and just giving # them utf8 encoded Strings. -- cgit