From faccd2f31af9bf13dedc6366933e5ee0fe37d05f Mon Sep 17 00:00:00 2001 From: rexy712 Date: Sun, 12 Jan 2020 18:06:17 -0800 Subject: [PATCH] Add naming convention documentation --- doc/naming_convention.txt | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 doc/naming_convention.txt diff --git a/doc/naming_convention.txt b/doc/naming_convention.txt new file mode 100644 index 0000000..0c22544 --- /dev/null +++ b/doc/naming_convention.txt @@ -0,0 +1,9 @@ +rjp_init_* = initialize passed pointer +rjp_delete_* = cleanup internal structures +rjp_new_* = rjp_malloc new value and initialize it +rjp_free_* = cleanup internal structures and rjp_free passed pointer + +irjp_* = internal function +rjp_* = api function + +RJP_* = data type name/typedef