Browse Source

[1179] doc update

Jelte Jansen 13 years ago
parent
commit
0aa89cf84c

+ 1 - 1
src/lib/python/isc/datasrc/client_inc.cc

@@ -157,7 +157,7 @@ specific derived class implementation).\n\
 If replace is true, any existing RRs of the zone will be deleted on\n\
 If replace is true, any existing RRs of the zone will be deleted on\n\
 successful completion of updates (after commit() on the updater); if\n\
 successful completion of updates (after commit() on the updater); if\n\
 it's false, the existing RRs will be intact unless explicitly deleted\n\
 it's false, the existing RRs will be intact unless explicitly deleted\n\
-by delete_r_rset() on the updater.\n\
+by delete_rrset() on the updater.\n\
 \n\
 \n\
 A data source can be \"read only\" or can prohibit partial updates. In\n\
 A data source can be \"read only\" or can prohibit partial updates. In\n\
 such cases this method will result in an isc.NotImplemented exception\n\
 such cases this method will result in an isc.NotImplemented exception\n\

+ 1 - 1
src/lib/python/isc/datasrc/datasrc.cc

@@ -172,7 +172,7 @@ PyModuleDef iscDataSrc = {
     "These bindings are close match to the C++ API, but they are not complete "
     "These bindings are close match to the C++ API, but they are not complete "
     "(some parts are not needed) and some are done in more python-like ways.",
     "(some parts are not needed) and some are done in more python-like ways.",
     -1,
     -1,
-    NULL,// TODO do we need module-level functions?
+    NULL,
     NULL,
     NULL,
     NULL,
     NULL,
     NULL,
     NULL,

+ 2 - 1
src/lib/python/isc/datasrc/iterator_inc.cc

@@ -10,10 +10,11 @@ used. This is the abstract interface.\n\
 \n\
 \n\
 There's no way to start iterating from the beginning again or return.\n\
 There's no way to start iterating from the beginning again or return.\n\
 \n\
 \n\
+The ZoneIterator is a python iterator, and can be iterated over directly.\n\
 ";
 ";
 
 
 const char* const ZoneIterator_getNextRRset_doc = "\
 const char* const ZoneIterator_getNextRRset_doc = "\
-get_next_r_rset() -> isc.dns.ConstRRset\n\
+get_next_rrset() -> isc.dns.ConstRRset\n\
 \n\
 \n\
 Get next RRset from the zone.\n\
 Get next RRset from the zone.\n\
 \n\
 \n\

+ 9 - 31
src/lib/python/isc/datasrc/updater_inc.cc

@@ -11,11 +11,11 @@ identify the zone to be updated). The underlying realization of a\n\
 a general purpose database as a backend, it will involve performing\n\
 a general purpose database as a backend, it will involve performing\n\
 some form of \"begin transaction\" statement for the database.\n\
 some form of \"begin transaction\" statement for the database.\n\
 \n\
 \n\
-Updates (adding or deleting RRs) are made via add_r_rset() and\n\
-delete_r_rset() methods. Until the commit() method is called the\n\
+Updates (adding or deleting RRs) are made via add_rrset() and\n\
+delete_rrset() methods. Until the commit() method is called the\n\
 changes are local to the updater object. For example, they won't be\n\
 changes are local to the updater object. For example, they won't be\n\
 visible via a ZoneFinder object except the one returned by the\n\
 visible via a ZoneFinder object except the one returned by the\n\
-updater's own get_finder() method. The commit() completes the\n\
+updater's own find() method. The commit() completes the\n\
 transaction and makes the changes visible to others.\n\
 transaction and makes the changes visible to others.\n\
 \n\
 \n\
 This class does not provide an explicit \"rollback\" interface. If\n\
 This class does not provide an explicit \"rollback\" interface. If\n\
@@ -30,38 +30,16 @@ adding and deleting RRs (see the description of the related methods).\n\
 It may be revisited as we gain more experiences.\n\
 It may be revisited as we gain more experiences.\n\
 \n\
 \n\
 ";
 ";
-/*
-const char* const ZoneUpdater_getFinder_doc = "\
-get_finder() -> ZoneFinder \n\
-\n\
-Return a finder for the zone being updated.\n\
-\n\
-The returned finder provides the functionalities of ZoneFinder for the\n\
-zone as updates are made via the updater. That is, before making any\n\
-update, the finder will be able to find all RRsets that exist in the\n\
-zone at the time the updater is created. If RRsets are added or\n\
-deleted via add_r_rset() or delete_r_rset(), this finder will find the\n\
-added ones or miss the deleted ones respectively.\n\
-\n\
-The finder returned by this method is effective only while the updates\n\
-are performed, i.e., from the construction of the corresponding\n\
-updater until commit() is performed or the updater is destructed\n\
-without commit. The result of a subsequent call to this method (or the\n\
-use of the result) after that is undefined.\n\
-\n\
-A reference to a ZoneFinder for the updated zone\n\
-\n\
-";
-*/
+
 const char* const ZoneUpdater_addRRset_doc = "\
 const char* const ZoneUpdater_addRRset_doc = "\
-add_r_rset(rrset) -> void\n\
+add_rrset(rrset) -> void\n\
 \n\
 \n\
 Add an RRset to a zone via the updater.\n\
 Add an RRset to a zone via the updater.\n\
 \n\
 \n\
 - Whether the RR class is identical to that for the zone to be updated\n\
 - Whether the RR class is identical to that for the zone to be updated\n\
 - Whether the RRset is not empty, i.e., it has at least one RDATA\n\
 - Whether the RRset is not empty, i.e., it has at least one RDATA\n\
 - Whether the RRset is not associated with an RRSIG, i.e., whether\n\
 - Whether the RRset is not associated with an RRSIG, i.e., whether\n\
-  get_r_rsig() on the RRset returns a NULL pointer.\n\
+  get_rrsig() on the RRset returns a NULL pointer.\n\
 \n\
 \n\
 and otherwise does not check any oddity. For example, it doesn't check\n\
 and otherwise does not check any oddity. For example, it doesn't check\n\
 whether the owner name of the specified RRset is a subdomain of the\n\
 whether the owner name of the specified RRset is a subdomain of the\n\
@@ -123,11 +101,11 @@ Parameters:\n\
 ";
 ";
 
 
 const char* const ZoneUpdater_deleteRRset_doc = "\
 const char* const ZoneUpdater_deleteRRset_doc = "\
-delete_r_rset(rrset) -> void\n\
+delete_rrset(rrset) -> void\n\
 \n\
 \n\
 Delete an RRset from a zone via the updater.\n\
 Delete an RRset from a zone via the updater.\n\
 \n\
 \n\
-Like add_r_rset(), the detailed semantics and behavior of this method\n\
+Like add_rrset(), the detailed semantics and behavior of this method\n\
 may have to be revisited in a future version. The following are based\n\
 may have to be revisited in a future version. The following are based\n\
 on the initial implementation decisions.\n\
 on the initial implementation decisions.\n\
 \n\
 \n\
@@ -149,7 +127,7 @@ when deleting RRs.\n\
 - Whether the RR class is identical to that for the zone to be updated\n\
 - Whether the RR class is identical to that for the zone to be updated\n\
 - Whether the RRset is not empty, i.e., it has at least one RDATA\n\
 - Whether the RRset is not empty, i.e., it has at least one RDATA\n\
 - Whether the RRset is not associated with an RRSIG, i.e., whether\n\
 - Whether the RRset is not associated with an RRSIG, i.e., whether\n\
-  get_r_rsig() on the RRset returns a NULL pointer.\n\
+  get_rrsig() on the RRset returns a NULL pointer.\n\
 \n\
 \n\
 This method must not be called once commit() is performed. If it calls\n\
 This method must not be called once commit() is performed. If it calls\n\
 after commit() the implementation must throw a DataSourceError\n\
 after commit() the implementation must throw a DataSourceError\n\