Add common/headers.h

dyninst · Apr 3, 2024 · e3a3cb5 · e3a3cb5
1 parent 8b79bda
commit e3a3cb5
Showing 1 changed file with 21 additions and 1 deletion.
diff --git a/docs/common/developer/headers.h.rst b/docs/common/developer/headers.h.rst
@@ -3,5 +3,25 @@
 headers.h
 #########
 
-.. cpp:namespace:: Dyninst
+Kludges to handle broken system includes and such...
 
+.. code:: cpp
+
+  #if defined(os_linux)
+  # include "common/src/linuxHeaders.h"
+  #elif defined(os_freebsd)
+  # include "common/src/freebsdHeaders.h"
+  #elif defined(os_windows)
+  # include "common/src/ntHeaders.h"
+  #endif
+
+.. cpp:enum:: readReturnValue_t 
+
+  .. cpp:enumerator:: RRVsuccess
+  .. cpp:enumerator:: RRVnoData
+  .. cpp:enumerator:: RRVinsufficientData
+  .. cpp:enumerator:: RRVreadError
+  .. cpp:enumerator:: RRVerror
+
+.. cpp:function:: template <class T> readReturnValue_t P_socketRead(PDSOCKET fd, T &it, ssize_t sz)
+.. cpp:function:: template<class T> readReturnValue_t P_socketRead(PDSOCKET fd, T &it)