X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;ds=sidebyside;f=Usermode%2Finclude%2Faxwin3%2Faxwin.h;h=49fc4df310a5265f49a2a43f62284abaebb717a8;hb=4fa95391e2ff812412d7229e0135efd49cd5f3ed;hp=6564e23c3669498baedff1227d1f2cb12ceee91d;hpb=d02fc5f32e4fbdc49361090537eaa5c64ae3d6f9;p=tpg%2Facess2.git

diff --git a/Usermode/include/axwin3/axwin.h b/Usermode/include/axwin3/axwin.h
index 6564e23c..49fc4df3 100644
--- a/Usermode/include/axwin3/axwin.h
+++ b/Usermode/include/axwin3/axwin.h
@@ -14,14 +14,35 @@ typedef void	(*tAxWin3_MessageCallback)(int SourceTID, int Length);
 
 typedef int	(*tAxWin3_WindowMessageHandler)(tHWND Window, int Length, void *Data);
 
+// --- Connection management
 extern void	AxWin3_Connect(const char *ServerDesc);
 extern tAxWin3_MessageCallback	AxWin3_SetMessageCallback(tAxWin3_MessageCallback Callback);
 extern void	AxWin3_MainLoop(void);
 
-extern tHWND	AxWin3_CreateWindow(tHWND Parent, const char *Renderer, int Flags, int DataBytes, void **DataPtr,
-	tAxWin3_WindowMessageHandler MessageHandler);
+// --- Window creation/deletion
+/**
+ * \brief Create a new window (with the required client structures)
+ * \param Parent	Parent window handle
+ * \param Renderer	Symbolic name of the renderer to use
+ * \param RendererArg	Argument to pass to the renderer's initialisation
+ * \param DataBytes	Number of bytes to allocate for the caller's use
+ * \param MessageHandler	Function to call when a message arrives for the window
+ * \return New window handle
+ * \note Usually wrapped by renderer-specific functions
+ */
+extern tHWND	AxWin3_CreateWindow(
+	tHWND Parent,
+	const char *Renderer, int RendererArg,
+	int DataBytes,
+	tAxWin3_WindowMessageHandler MessageHandler
+	);
+/**
+ * \brief Destroy a window
+ * \param Window	Handle to a window to destroy
+ */
 extern void	AxWin3_DestroyWindow(tHWND Window);
 
+// --- Core window management functions
 extern void	AxWin3_SendMessage(tHWND Window, int Length, void *Data);
 extern void	AxWin3_ShowWindow(tHWND Window, int bShow);
 extern void	AxWin3_SetWindowPos(tHWND Window, short X, short Y, short W, short H);