Add naming convention documentation

2020-01-12 18:06:17 -08:00 · 2020-01-12 18:06:17 -08:00 · faccd2f31a
commit faccd2f31a
parent 12388ac8f6
1 changed files with 9 additions and 0 deletions
--- a/doc/naming_convention.txt
+++ 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