From e3d98796909d3a1595b75786e14f7495dc7a0ea9 Mon Sep 17 00:00:00 2001
From: planetmaker <planetmaker@openttd.org>
Date: Thu, 21 Jul 2011 16:13:34 +0000
Subject: (svn r22678) -Doc: More doxygen sprinkles in MacOSX code and cocoa
 video driver

---
 src/os/macosx/splash.cpp | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'src/os/macosx/splash.cpp')

diff --git a/src/os/macosx/splash.cpp b/src/os/macosx/splash.cpp
index c56491fa4..1fb98ebf5 100644
--- a/src/os/macosx/splash.cpp
+++ b/src/os/macosx/splash.cpp
@@ -23,17 +23,32 @@
 
 #include <png.h>
 
+/**
+ * Handle pnglib error.
+ *
+ * @param png_ptr Pointer to png struct.
+ * @param message Error message text.
+ */
 static void PNGAPI png_my_error(png_structp png_ptr, png_const_charp message)
 {
 	DEBUG(misc, 0, "[libpng] error: %s - %s", message, (char *)png_get_error_ptr(png_ptr));
 	longjmp(png_jmpbuf(png_ptr), 1);
 }
 
+/**
+ * Handle warning in pnglib.
+ *
+ * @param png_ptr Pointer to png struct.
+ * @param message Warning message text.
+ */
 static void PNGAPI png_my_warning(png_structp png_ptr, png_const_charp message)
 {
 	DEBUG(misc, 1, "[libpng] warning: %s - %s", message, (char *)png_get_error_ptr(png_ptr));
 }
 
+/**
+ * Display a splash image shown on startup (WITH_PNG).
+ */
 void DisplaySplashImage()
 {
 	FILE *f = FioFOpenFile(SPLASH_IMAGE_FILE);
@@ -162,6 +177,9 @@ void DisplaySplashImage()
 
 #else /* WITH_PNG */
 
+/**
+ * Empty 'Display a splash image' routine (WITHOUT_PNG).
+ */
 void DisplaySplashImage() {}
 
 #endif /* WITH_PNG */
-- 
cgit v1.2.3-70-g09d2