changeset 543:c32d7a98bde1

rpg: rpg -> mlk_rpg
author David Demelier <markand@malikania.fr>
date Sun, 05 Mar 2023 13:15:05 +0100
parents 82fd0dd6cc19
children 0ff9f4a5c364
files libmlk-example/mlk/example/example.c libmlk-rpg/mlk/rpg/rpg.c libmlk-rpg/mlk/rpg/rpg.h
diffstat 3 files changed, 20 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/libmlk-example/mlk/example/example.c	Sun Mar 05 13:10:13 2023 +0100
+++ b/libmlk-example/mlk/example/example.c	Sun Mar 05 13:15:05 2023 +0100
@@ -40,7 +40,7 @@
 		return err;
 	if ((err = mlk_ui_init()) < 0)
 		return err;
-	if ((err = rpg_init()) < 0)
+	if ((err = mlk_rpg_init()) < 0)
 		return err;
 	if (mlk_window_open(name, MLK_EXAMPLE_W, MLK_EXAMPLE_H) < 0)
 		return err;
@@ -54,7 +54,7 @@
 mlk_example_finish(void)
 {
 	mlk_window_finish();
-	rpg_finish();
+	mlk_rpg_finish();
 	mlk_ui_finish();
 	mlk_core_finish();
 }
--- a/libmlk-rpg/mlk/rpg/rpg.c	Sun Mar 05 13:10:13 2023 +0100
+++ b/libmlk-rpg/mlk/rpg/rpg.c	Sun Mar 05 13:15:05 2023 +0100
@@ -19,12 +19,12 @@
 #include "rpg.h"
 
 int
-rpg_init(void)
+mlk_rpg_init(void)
 {
 	return 0;
 }
 
 void
-rpg_finish(void)
+mlk_rpg_finish(void)
 {
 }
--- a/libmlk-rpg/mlk/rpg/rpg.h	Sun Mar 05 13:10:13 2023 +0100
+++ b/libmlk-rpg/mlk/rpg/rpg.h	Sun Mar 05 13:15:05 2023 +0100
@@ -1,5 +1,5 @@
 /*
- * rpg.h -- librpg convenient header
+ * rpg.h -- libmlk-rpg main entry
  *
  * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
  *
@@ -19,15 +19,28 @@
 #ifndef MLK_RPG_RPG_H
 #define MLK_RPG_RPG_H
 
+/**
+ * \file mlk/rpg/rpg.h
+ * \brief libmlk-rpg main entry
+ */
+
 #if defined(__cplusplus)
 extern "C" {
 #endif
 
+/**
+ * Initialize the RPG library.
+ *
+ * \return 0 on success or any error code instead
+ */
 int
-rpg_init(void);
+mlk_rpg_init(void);
 
+/**
+ * Cleanup resources allocated by the library.
+ */
 void
-rpg_finish(void);
+mlk_rpg_finish(void);
 
 #if defined(__cplusplus)
 }