Fix some comments about undocumented functions in public headers.

These functions have long been documented.

diff --git a/include/cln/complex_io.h b/include/cln/complex_io.h
index 1d6a9b97ff1e1d30a226e8b04a43485f07798abf..33c7aff78a52358fe58d4e649c7657e807daad67 100644 (file)
--- a/include/cln/complex_io.h
+++ b/include/cln/complex_io.h
@@ -8,13 +8,11 @@
 
 namespace cln {
 
-// Undocumented input functions
+// Input functions
 
 extern const cl_N read_complex (const cl_read_flags& flags, const char * string, const char * string_limit, const char * * end_of_parse);
 extern const cl_N read_complex (std::istream& stream, const cl_read_flags& flags);
 
-// Documented input functions
-
 inline std::istream& operator>> (std::istream& stream, cl_N& result)
 {
        extern cl_read_flags cl_N_read_flags;
@@ -23,10 +21,7 @@ inline std::istream& operator>> (std::istream& stream, cl_N& result)
 }
 
 
-// Undocumented output functions
-
-
-// Documented output functions
+// Output functions
 
 // Gibt eine komplexe Zahl aus.
 // print_complex(stream,z);

diff --git a/include/cln/float_io.h b/include/cln/float_io.h
index f7e121949e549d425dd3de433331c2327bb88a3b..3815f21e3b4291e2587061fc3297ccce36d233c4 100644 (file)
--- a/include/cln/float_io.h
+++ b/include/cln/float_io.h
@@ -8,7 +8,7 @@
 
 namespace cln {
 
-// Undocumented input functions
+// Input functions
 
 // Wandelt eine Zeichenkette mit Float-Syntax in ein Float um.
 // read_float(base,sign,string,index1,index4,index2,index3)
@@ -34,8 +34,6 @@ extern const cl_F read_float (unsigned int base, float_format_t prec,
 extern const cl_F read_float (const cl_read_flags& flags, const char * string, const char * string_limit, const char * * end_of_parse);
 extern const cl_F read_float (std::istream& stream, const cl_read_flags& flags);
 
-// Documented input functions
-
 inline std::istream& operator>> (std::istream& stream, cl_F& result)
 {
        extern cl_read_flags cl_F_read_flags;
@@ -44,10 +42,7 @@ inline std::istream& operator>> (std::istream& stream, cl_F& result)
 }
 
 
-// Undocumented output functions
-
-
-// Documented output functions
+// Output functions
 
 // Gibt ein Float aus.
 // print_float(stream,z);

diff --git a/include/cln/integer_io.h b/include/cln/integer_io.h
index c1d2b60ee1fe990d3857f5e2d3c4b4f7c69ca5b1..fd319bc12d8dc2ab0db056b43387eb54173002f3 100644 (file)
--- a/include/cln/integer_io.h
+++ b/include/cln/integer_io.h
@@ -8,7 +8,7 @@
 
 namespace cln {
 
-// Undocumented input functions
+// Input functions
 
 // Wandelt eine Zeichenkette mit Integer-Syntax in ein Integer um.
 // Punkte werden überlesen.
@@ -29,8 +29,6 @@ extern const cl_I read_integer (unsigned int base,
 extern const cl_I read_integer (const cl_read_flags& flags, const char * string, const char * string_limit, const char * * end_of_parse);
 extern const cl_I read_integer (std::istream& stream, const cl_read_flags& flags);
 
-// Documented input functions
-
 inline std::istream& operator>> (std::istream& stream, cl_I& result)
 {
        extern cl_read_flags cl_I_read_flags;
@@ -39,7 +37,7 @@ inline std::istream& operator>> (std::istream& stream, cl_I& result)
 }
 
 
-// Undocumented output functions
+// Output functions
 
 // Liefert zu einem Integer >=0  (write-to-string integer :base 10 :radix nil),
 // also die Ziffernfolge als String.
@@ -55,9 +53,6 @@ extern void print_integer (std::ostream& stream, unsigned int base, const cl_I&
 // Dasselbe als String. Mit malloc_hook() alloziert, mit free_hook() freizugeben.
 extern char * print_integer_to_string (unsigned int base, const cl_I& z);
 
-
-// Documented output functions
-
 inline void fprintdecimal (std::ostream& stream, const cl_I& x)
 {
        print_integer(stream,10,x);

diff --git a/include/cln/rational_io.h b/include/cln/rational_io.h
index a9552218df5429bbd63ee5b356e4d96a26bccc07..3dee1a7fec05d7d96a166852d06910a7530b2776 100644 (file)
--- a/include/cln/rational_io.h
+++ b/include/cln/rational_io.h
@@ -8,7 +8,7 @@
 
 namespace cln {
 
-// Undocumented input functions
+// Input functions
 
 // Wandelt eine Zeichenkette mit Rational-Syntax in eine rationale Zahl um.
 // read_rational(base,sign,string,index1,index3,index2)
@@ -29,8 +29,6 @@ extern const cl_RA read_rational (unsigned int base,
 extern const cl_RA read_rational (const cl_read_flags& flags, const char * string, const char * string_limit, const char * * end_of_parse);
 extern const cl_RA read_rational (std::istream& stream, const cl_read_flags& flags);
 
-// Documented input functions
-
 inline std::istream& operator>> (std::istream& stream, cl_RA& result)
 {
        extern cl_read_flags cl_RA_read_flags;
@@ -39,7 +37,7 @@ inline std::istream& operator>> (std::istream& stream, cl_RA& result)
 }
 
 
-// Undocumented output functions
+// Output functions
 
 // Gibt eine rationale Zahl aus.
 // print_rational(stream,base,z);
@@ -48,9 +46,6 @@ inline std::istream& operator>> (std::istream& stream, cl_RA& result)
 // > stream: Stream
 extern void print_rational (std::ostream& stream, unsigned int base, const cl_RA& z);
 
-
-// Documented output functions
-
 // Gibt eine Zahl aus.
 // print_rational(stream,flags,z);
 // > z: Zahl

diff --git a/include/cln/real_io.h b/include/cln/real_io.h
index ce1e544bc371a215742b675e2f49f490f6988253..9acfb2f41bd737894d757807c021d662e787a521 100644 (file)
--- a/include/cln/real_io.h
+++ b/include/cln/real_io.h
@@ -8,7 +8,7 @@
 
 namespace cln {
 
-// Undocumented input functions
+// Input functions
 
 // The following does strictly the same as the general read_complex.
 // It is here only so that you don't need the complex number reader
@@ -16,8 +16,6 @@ namespace cln {
 extern const cl_R read_real (const cl_read_flags& flags, const char * string, const char * string_limit, const char * * end_of_parse);
 extern const cl_R read_real (std::istream& stream, const cl_read_flags& flags);
 
-// Documented input functions
-
 inline std::istream& operator>> (std::istream& stream, cl_R& result)
 {
        extern cl_read_flags cl_R_read_flags;
@@ -26,10 +24,7 @@ inline std::istream& operator>> (std::istream& stream, cl_R& result)
 }
 
 
-// Undocumented output functions
-
-
-// Documented output functions
+// Output functions
 
 // Gibt eine Zahl aus.
 // print_real(stream,flags,z);