Merge pull request #4314 from wilzbach/public_document_curl

std.curl: document public methods

std/net/curl.d

@@ -313,8 +313,6 @@ version(unittest)
 }
 version(StdDdoc) import std.stdio;
 
-extern (C) void exit(int);
-
 // Default data timeout for Protocols
 private enum _defaultDataTimeout = dur!"minutes"(2);
 
@@ -1511,12 +1509,10 @@ private mixin template WorkerThreadProtocol(Unit, alias units)
     }
 }
 
-// Workaround bug #2458
-// It should really be defined inside the byLineAsync method.
-// Do not create instances of this struct since it will be
-// moved when the bug has been fixed.
+// @@@@BUG 15831@@@@
+// this should be inside byLineAsync
 // Range that reads one line at a time asynchronously.
-static struct AsyncLineInputRange(Char)
+private static struct AsyncLineInputRange(Char)
 {
     private Char[] line;
     mixin WorkerThreadProtocol!(Char, line);
@@ -1540,7 +1536,6 @@ static struct AsyncLineInputRange(Char)
     }
 }
 
-
 /** HTTP/FTP fetch content as a range of lines asynchronously.
  *
  * A range of lines is returned immediately and the request that fetches the
@@ -1665,13 +1660,10 @@ unittest
     }
 }
 
-
-// Workaround bug #2458
-// It should really be defined inside the byLineAsync method.
-// Do not create instances of this struct since it will be
-// moved when the bug has been fixed.
+// @@@@BUG 15831@@@@
+// this should be inside byLineAsync
 // Range that reads one chunk at a time asynchronously.
-static struct AsyncChunkInputRange
+private static struct AsyncChunkInputRange
 {
     private ubyte[] chunk;
     mixin WorkerThreadProtocol!(ubyte, chunk);
@@ -2446,13 +2438,15 @@ struct HTTP
         return http;
     }
 
+    ///
     static HTTP opCall()
     {
         HTTP http;
         http.initialize();
         return http;
     }
 
+    ///
     HTTP dup()
     {
         HTTP copy;
@@ -3184,13 +3178,15 @@ struct FTP
         return ftp;
     }
 
+    ///
     static FTP opCall()
     {
         FTP ftp;
         ftp.initialize();
         return ftp;
     }
 
+    ///
     FTP dup()
     {
         FTP copy = FTP();
@@ -3525,6 +3521,7 @@ struct SMTP
         return smtp;
     }
 
+    ///
     static SMTP opCall()
     {
         SMTP smtp;
@@ -3974,7 +3971,7 @@ struct Curl
 {
     alias OutData = void[];
     alias InData = ubyte[];
-    bool stopped;
+    private bool _stopped;
 
     private static auto ref curl() @property { return CurlAPI.instance; }
 
@@ -4001,10 +3998,16 @@ struct Curl
         enforce!CurlException(!handle, "Curl instance already initialized");
         handle = curl.easy_init();
         enforce!CurlException(handle, "Curl instance couldn't be initialized");
-        stopped = false;
+        _stopped = false;
         set(CurlOption.nosignal, 1);
     }
 
+    ///
+    @property bool stopped() const
+    {
+        return _stopped;
+    }
+
     /**
        Duplicate this handle.
 
@@ -4017,7 +4020,7 @@ struct Curl
     {
         Curl copy;
         copy.handle = curl.easy_duphandle(handle);
-        copy.stopped = false;
+        copy._stopped = false;
 
         with (CurlOption) {
             auto tt = AliasSeq!(file, writefunction, writeheader,
@@ -4095,7 +4098,7 @@ struct Curl
     void shutdown()
     {
         throwOnStopped();
-        stopped = true;
+        _stopped = true;
         curl.easy_cleanup(this.handle);
         this.handle = null;
     }