adding comments

Author: Expander

src/c/log.c

@@ -40,6 +40,13 @@ long double _Complex clog1pl(long double _Complex z)
 }
 
 
+/**
+ * returns log(z) for complex z
+ * @param z complex argument
+ * @note Points on the branch cut are treated differently from std::log(z):
+ * Points with Re(z) < 0 and Im(z) == -0.0 are mapped to Im(z) == 0.0
+ * @return log(z)
+ */
 double _Complex pos_clog(double _Complex z)
 {
    const double rz = creal(z);
@@ -55,6 +62,13 @@ double _Complex pos_clog(double _Complex z)
 }
 
 
+/**
+ * returns log(z) for complex z
+ * @param z complex argument
+ * @note Points on the branch cut are treated differently from std::log(z):
+ * Points with Re(z) < 0 and Im(z) == -0.0 are mapped to Im(z) == 0.0
+ * @return log(z)
+ */
 long double _Complex pos_clogl(long double _Complex z)
 {
    const long double rz = creall(z);

src/c/log.h

@@ -12,8 +12,8 @@ double _Complex clog1p(double _Complex z);
 /** returns clog(1 + z) with long double precision */
 long double _Complex clog1pl(long double _Complex z);
 
-/** returns clog(z) with double precision, treating -0.0 correctly */
+/** returns clog(z) with double precision */
 double _Complex pos_clog(double _Complex z);
 
-/** returns clog(z) with long double precision, treating -0.0L correctly */
+/** returns clog(z) with long double precision */
 long double _Complex pos_clogl(long double _Complex z);

src/cpp/log.hpp

@@ -12,6 +12,7 @@
 namespace polylogarithm {
 
 
+/// returns log(1 + z) for complex z
 template <typename T>
 std::complex<T> log1p(const std::complex<T>& z) noexcept
 {
@@ -27,6 +28,13 @@ std::complex<T> log1p(const std::complex<T>& z) noexcept
 }
 
 
+/**
+ * returns log(z) for complex z
+ * @param z complex argument
+ * @note Points on the branch cut are treated differently from std::log(z):
+ * Points with Re(z) < 0 and Im(z) == -0.0 are mapped to Im(z) == 0.0
+ * @return log(z)
+ */
 template <typename T>
 std::complex<T> pos_log(const std::complex<T>& z) noexcept
 {