dj0tt / arduino

Automatically exported from code.google.com/p/arduino
Other
0 stars 0 forks source link

Ethernet library documentation omission #1034

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Both the ethernet client and server documentation has an omission on the write 
function.

Both the EthernetClient.h and EthernetServer.h have these declarations.

  virtual size_t write(uint8_t);
  virtual size_t write(const uint8_t *buf, size_t size);

The second declaration is not covered by the current documentation.
http://arduino.cc/en/Reference/ClientWrite
http://arduino.cc/en/Reference/ServerWrite

I think that is an important function to document.

Original issue reported on code.google.com by t...@prolectron.com on 5 Sep 2012 at 2:29

GoogleCodeExporter commented 9 years ago
I forgot to include that this required a byte array pointer to compile 
correctly. On mine, a character array pointer threw a data type error. This is 
the most efficient way of sending byte data that contains zeros.

Original comment by t...@prolectron.com on 5 Sep 2012 at 2:58

GoogleCodeExporter commented 9 years ago
Add UDP.write to that change also. Nothing in the docs about the second version 
of the write function, even tho it is in the library.
http://arduino.cc/en/Reference/EthernetUDPWrite

Original comment by t...@prolectron.com on 20 Sep 2012 at 12:06

GoogleCodeExporter commented 9 years ago
documentation has been updated

Original comment by sc...@droolcup.com on 30 Oct 2013 at 12:22

GoogleCodeExporter commented 9 years ago

Original comment by s.fitzge...@arduino.cc on 30 Oct 2013 at 12:23