Add some missing file comments in source/lib.

win_internal -> win.h (pulls in <windows.h>, with fixes afterwards)
remove empty waio_internal and wsysdep
Move source/sound license notice into source/sound/license.txt

This was SVN commit r5044.

source/lib/external_libraries/png.h

@@ -1,3 +1,13 @@
+/**
+ * =========================================================================
+ * File        : png.h
+ * Project     : 0 A.D.
+ * Description : bring in LibPNG header+library, with compatibility fixes
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 // <png.h> includes <zlib.h>, which requires some fixes by our header.
 #include "lib/external_libraries/zlib.h"
 

source/lib/external_libraries/sdl_fwd.h

@@ -1,3 +1,13 @@
+/**
+ * =========================================================================
+ * File        : sdl_fwd.h
+ * Project     : 0 A.D.
+ * Description : forward declaration of SDL_Event
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 #ifndef INCLUDED_SDL_FWD
 #define INCLUDED_SDL_FWD
 
@@ -9,7 +19,7 @@
 // SDL_Event is needed. unfortunately it cannot be forward-declared,
 // because it is a union (regrettable design mistake).
 // we fix this by wrapping it in a struct, which can safely be
-// forward-declared and used for pointers.
+// forward-declared and used for SDL_Event_* parameters.
 struct SDL_Event_;
 
 #endif	// #ifndef INCLUDED_SDL_FWD

source/lib/external_libraries/wxwidgets.h

@@ -2,7 +2,7 @@
  * =========================================================================
  * File        : wxwidgets.h
  * Project     : 0 A.D.
- * Description : pulls in wxWidgets headers, with compatibility fixes
+ * Description : bring in wxWidgets headers, with compatibility fixes
  * =========================================================================
  */
 

source/lib/external_libraries/zlib.h

@@ -1,3 +1,13 @@
+/**
+ * =========================================================================
+ * File        : zlib.h
+ * Project     : 0 A.D.
+ * Description : bring in ZLib header+library, with compatibility fixes
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 // zlib.h -> zconf.h includes <windows.h>, which causes conflicts.
 // define the include guard to prevent it from actually being included and
 // then manually define the few things that are actually needed.

source/lib/res/file/file_util.cpp

@@ -1,3 +1,13 @@
+/**
+ * =========================================================================
+ * File        : file_util.cpp
+ * Project     : 0 A.D.
+ * Description : utility functions for file and path handling modules
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 #include "precompiled.h"
 
 #include <queue>

source/lib/res/handle.h

@@ -1,4 +1,12 @@
-// define "Handle". split out of h_mgr.h to reduce dependencies.
+/**
+ * =========================================================================
+ * File        : handle.h
+ * Project     : 0 A.D.
+ * Description : forward declaration of Handle (reduces dependencies)
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
 
 #ifndef INCLUDED_HANDLE
 #define INCLUDED_HANDLE

source/lib/res/sound/snd_mgr.cpp

@@ -31,7 +31,7 @@
 
 // for DLL-load hack in alc_init
 #if OS_WIN
-# include "lib/sysdep/win/win_internal.h"
+# include "lib/sysdep/win/win.h"
 #endif
 
 #include "lib/res/res.h"

source/lib/secure_crt.cpp

@@ -1,3 +1,13 @@
+/**
+ * =========================================================================
+ * File        : secure_crt.cpp
+ * Project     : 0 A.D.
+ * Description : partial implementation of VC8's secure CRT functions
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 #include "precompiled.h"
 
 #include <stdio.h>

source/lib/secure_crt.h

@@ -1,3 +1,13 @@
+/**
+ * =========================================================================
+ * File        : secure_crt.cpp
+ * Project     : 0 A.D.
+ * Description : partial implementation of VC8's secure CRT functions
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 #ifndef INCLUDED_SECURE_CRT
 #define INCLUDED_SECURE_CRT
 #if !HAVE_SECURE_CRT

source/lib/sysdep/compiler.h

@@ -1,7 +1,16 @@
+/**
+ * =========================================================================
+ * File        : compiler.h
+ * Project     : 0 A.D.
+ * Description : compiler-specific macros and fixes
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 #ifndef INCLUDED_COMPILER
 #define INCLUDED_COMPILER
 
-
 // pass "omit frame pointer" setting on to the compiler
 #if MSC_VERSION
 # if CONFIG_OMIT_FP

source/lib/sysdep/ia32/ia32.cpp

@@ -2,7 +2,7 @@
  * =========================================================================
  * File        : ia32.cpp
  * Project     : 0 A.D.
- * Description : C++ and inline asm implementations for IA-32.
+ * Description : C++ and inline asm implementations of IA-32 functions
  * =========================================================================
  */
 

source/lib/sysdep/ia32/ia32.h

@@ -2,7 +2,7 @@
  * =========================================================================
  * File        : ia32.h
  * Project     : 0 A.D.
- * Description : C++ and inline asm implementations for IA-32.
+ * Description : C++ and inline asm implementations of IA-32 functions
  * =========================================================================
  */
 

source/lib/sysdep/ia32/ia32_asm.h

@@ -1,3 +1,13 @@
+/**
+ * =========================================================================
+ * File        : ia32_asm.h
+ * Project     : 0 A.D.
+ * Description : interface to various IA-32 functions (written in asm)
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 #ifndef INCLUDED_IA32_ASM
 #define INCLUDED_IA32_ASM
 

source/lib/sysdep/ia32/ia32_memcpy.h

@@ -1,3 +1,13 @@
+/**
+ * =========================================================================
+ * File        : ia32_memcpy.h
+ * Project     : 0 A.D.
+ * Description : interface to highly optimized memcpy (written in asm)
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 #ifndef INCLUDED_IA32_MEMCPY
 #define INCLUDED_IA32_MEMCPY
 

source/lib/sysdep/ia32/ia32_memcpy_init.cpp

@@ -1,3 +1,13 @@
+/**
+ * =========================================================================
+ * File        : ia32_memcpy_init.cpp
+ * Project     : 0 A.D.
+ * Description : initialization for ia32_memcpy (detect CPU caps)
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 #include "precompiled.h"
 
 #include "ia32.h"

source/lib/sysdep/stl.h

@@ -1,3 +1,13 @@
+/**
+ * =========================================================================
+ * File        : stl.h
+ * Project     : 0 A.D.
+ * Description : fixes for various STL implementations
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 #ifndef INCLUDED_STL
 #define INCLUDED_STL
 

source/lib/sysdep/win/delay_load.cpp

@@ -14,7 +14,7 @@
 #include "delay_load.h"
 
 #include "lib/sysdep/cpu.h"
-#include "win_internal.h"
+#include "win.h"
 #include "winit.h"
 
 
@@ -626,3 +626,4 @@ EXTERN_C PfnDliHook __pfnDliFailureHook2 = 0;
 
 
 
+

source/lib/sysdep/win/dll_ver.cpp

@@ -15,7 +15,7 @@
 #include <stdlib.h>
 
 #include "lib/path_util.h"
-#include "win_internal.h"
+#include "win.h"
 #include "wutil.h"
 
 #if MSC_VERSION

source/lib/sysdep/win/tests/test_wdbg_sym.h

@@ -5,10 +5,10 @@
 
 #include "lib/self_test.h"
 
-#include "lib/sysdep/win/win_internal.h"	// HWND
+#include "lib/sysdep/win/win.h"	// HWND
 #include "lib/debug.h"	// no wdbg_sym interface needed
 #include "lib/sysdep/sysdep.h"
-#include "lib/sysdep/win/win_internal.h"
+#include "lib/sysdep/win/win.h"
 
 #include <queue>
 #include <deque>

source/lib/sysdep/win/wcpu.cpp

@@ -2,7 +2,7 @@
  * =========================================================================
  * File        : wcpu.cpp
  * Project     : 0 A.D.
- * Description : Windows-specific CPU related code
+ * Description : Windows backend for CPU related code
  * =========================================================================
  */
 
@@ -14,7 +14,7 @@
 #include "lib/lib.h"
 #include "lib/posix/posix_pthread.h"
 #include "lib/posix/posix_time.h"
-#include "win_internal.h"
+#include "win.h"
 #include "wutil.h"
 
 // limit allows statically allocated per-CPU structures (for simplicity).

source/lib/sysdep/win/wcpu.h

@@ -1,3 +1,13 @@
+/**
+ * =========================================================================
+ * File        : wcpu.h
+ * Project     : 0 A.D.
+ * Description : Windows backend for CPU related code
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 #ifndef INCLUDED_WCPU
 #define INCLUDED_WCPU
 

source/lib/sysdep/win/wdbg.cpp

@@ -20,7 +20,7 @@
 #include "lib/byte_order.h"		// FOURCC
 #include "lib/app_hooks.h"
 #include "lib/sysdep/cpu.h"
-#include "win_internal.h"
+#include "win.h"
 #include "wdbg_sym.h"
 #include "winit.h"
 #include "wutil.h"
@@ -801,3 +801,4 @@ bool debug_is_stack_ptr(void* p)
 
 
 
+

source/lib/sysdep/win/wdbg_sym.cpp

@@ -24,7 +24,7 @@
 #if CPU_IA32
 # include "lib/sysdep/ia32/ia32.h"
 #endif
-#include "win_internal.h"
+#include "win.h"
 #include "winit.h"
 #include "wutil.h"
 

source/lib/sysdep/win/wdbg_sym.h

@@ -1,3 +1,13 @@
+/**
+ * =========================================================================
+ * File        : wdbg_sym.h
+ * Project     : 0 A.D.
+ * Description : Win32 stack trace and symbol engine.
+ * =========================================================================
+ */
+
+// license: GPL; see lib/license.txt
+
 #ifndef INCLUDED_WDBG_SYM
 #define INCLUDED_WDBG_SYM
 

source/lib/sysdep/win/wdir_watch.cpp

@@ -18,7 +18,7 @@
 #include "lib/lib.h"
 #include "lib/path_util.h"
 #include "lib/res/file/file.h"	// path_is_subpath
-#include "win_internal.h"
+#include "win.h"
 #include "winit.h"
 #include "wutil.h"
 

source/lib/sysdep/win/wgfx.cpp

@@ -12,7 +12,7 @@
 #include "lib/sysdep/gfx.h"
 
 #include "dll_ver.h"	// dll_list_*
-#include "win_internal.h"
+#include "win.h"
 
 #if MSC_VERSION
 #pragma comment(lib, "advapi32.lib")	// registry

source/lib/sysdep/win/win.h

@@ -1,8 +1,8 @@
 /**
  * =========================================================================
- * File        : win_internal.h
+ * File        : win.h
  * Project     : 0 A.D.
- * Description : include <windows.h>, with compatibility fixes afterwards
+ * Description : bring in <windows.h> with compatibility fixes
  * =========================================================================
  */
 
@@ -12,7 +12,7 @@
 #define INCLUDED_WIN
 
 #if !OS_WIN
-#error "win_internal.h: do not include if not compiling for Windows"
+#error "win.h: do not include if not compiling for Windows"
 #endif
 
 // Win32 socket declarations aren't portable (e.g. problems with socklen_t)

source/lib/sysdep/win/wposix/waio_internal.h

@@ -1,7 +0,0 @@
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#ifdef __cplusplus
-}
-#endif

source/lib/sysdep/win/wposix/wposix_internal.h

@@ -2,7 +2,7 @@
 #define INCLUDED_WPOSIX_INTERNAL
 
 #include "lib/lib.h"
-#include "lib/sysdep/win/win_internal.h"
+#include "lib/sysdep/win/win.h"
 #include "lib/sysdep/win/winit.h"
 #include "lib/sysdep/win/wutil.h"
 

source/lib/sysdep/win/wprintf.cpp

@@ -1,3 +1,11 @@
+/**
+ * =========================================================================
+ * File        : wprintf.cpp
+ * Project     : 0 A.D.
+ * Description : implementation of sys_vsnprintf.
+ * =========================================================================
+ */
+
 #include "precompiled.h"
 
 /*

source/lib/sysdep/win/wsdl.cpp

@@ -16,7 +16,7 @@
 #include <queue>
 #include <algorithm>
 
-#include "win_internal.h"
+#include "win.h"
 #include <ddraw.h>
 #include <process.h>	// _beginthreadex
 #include <WindowsX.h>	// message crackers

source/lib/sysdep/win/wsnd.cpp

@@ -19,7 +19,7 @@
 #include "lib/path_util.h"
 #include "lib/res/file/file.h"
 #include "dll_ver.h"	// dll_list_*
-#include "win_internal.h"
+#include "win.h"
 #include "wutil.h"
 
 

source/lib/sysdep/win/wstartup.cpp

@@ -13,7 +13,7 @@
 
 #include "winit.h"
 #include "wdbg.h"			// wdbg_exception_filter
-#include "win_internal.h"	// GetExceptionInformation
+#include "win.h"	// GetExceptionInformation
 
 #if MSC_VERSION >= 1400
 #include <process.h>		// __security_init_cookie

source/lib/sysdep/win/wsysdep.cpp

@@ -11,7 +11,7 @@
 #include "precompiled.h"
 #include "lib/sysdep/sysdep.h"
 
-#include "win_internal.h"	// includes windows.h; must come before shlobj
+#include "win.h"	// includes windows.h; must come before shlobj
 #include <shlobj.h>	// pick_dir
 
 #include "lib/lib.h"
@@ -608,3 +608,4 @@ LibError sys_pick_directory(char* path, size_t buf_size)
 }
 
 
+

source/lib/sysdep/win/wsysdep.h

@@ -1,4 +0,0 @@
-#ifndef INCLUDED_WSYSDEP
-#define INCLUDED_WSYSDEP
-
-#endif	// #ifndef INCLUDED_WSYSDEP

source/lib/sysdep/win/wutil.cpp

@@ -16,7 +16,7 @@
 
 #include "lib/path_util.h"
 #include "lib/posix/posix.h"
-#include "win_internal.h"
+#include "win.h"
 #include "winit.h"
 
 

source/lib/sysdep/win/wutil.h

@@ -15,7 +15,7 @@
 #error "wutil.h: do not include if not compiling for Windows"
 #endif
 
-#include "win_internal.h"
+#include "win.h"
 
 
 //-----------------------------------------------------------------------------

source/network/SocketBase.cpp

@@ -1,7 +1,7 @@
 #include "precompiled.h"
 
 #if OS_WIN
-#include "lib/sysdep/win/win_internal.h"
+#include "lib/sysdep/win/win.h"
 #include "lib/sysdep/win/wposix/wsock_internal.h"
 #endif
 

source/sound/SoundGroup.cpp

@@ -7,34 +7,20 @@
 * =========================================================================
 */
 
-/*
- * Copyright (c) 2005-2006 Gavin Fowler
- *
- * Redistribution and/or modification are also permitted under the
- * terms of the GNU General Public License as published by the
- * Free Software Foundation (version 2 or later, at your option).
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- */
+// license: GPL; see sound/license.txt
 
 #include "precompiled.h"
+#include "SoundGroup.h"
 
 #include <algorithm>
 
-#include "SoundGroup.h"
-
 #include "ps/XML/Xeromyces.h"
-
 #include "ps/CLogger.h"
-
 #include "lib/lib.h"
 
 #define LOG_CATEGORY "audio"
 
 
-
 CSoundGroup::CSoundGroup()
 {
 	m_index = 0;

source/sound/SoundGroup.h

@@ -7,17 +7,7 @@
 * =========================================================================
 */
 
-/*
- * Copyright (c) 2005-2006 Gavin Fowler
- *
- * Redistribution and/or modification are also permitted under the
- * terms of the GNU General Public License as published by the
- * Free Software Foundation (version 2 or later, at your option).
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- */
+// license: GPL; see sound/license.txt
 
 /*
 Example usage: (SEE SOUNDGROUPMGR.H)

source/sound/SoundGroupMgr.cpp

@@ -6,17 +6,7 @@
 * =========================================================================
 */
 
-/*
- * Copyright (c) 2005-2006 Gavin Fowler
- *
- * Redistribution and/or modification are also permitted under the
- * terms of the GNU General Public License as published by the
- * Free Software Foundation (version 2 or later, at your option).
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- */
+// license: GPL; see sound/license.txt
 
 // Example usage: 
 

source/sound/SoundGroupMgr.h

@@ -6,18 +6,7 @@
 * =========================================================================
 */
 
-
-/*
- * Copyright (c) 2005-2006 Gavin Fowler
- *
- * Redistribution and/or modification are also permitted under the
- * terms of the GNU General Public License as published by the
- * Free Software Foundation (version 2 or later, at your option).
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- */
+// license: GPL; see sound/license.txt
 
 #include "SoundGroup.h"
 #include <vector>