aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichał Łyszczek <michal.lyszczek@bofc.pl>2019-05-16 22:31:33 +0200
committerMichał Łyszczek <michal.lyszczek@bofc.pl>2019-05-16 22:31:33 +0200
commitca5eece1b1a074f824962065f006361e55ec4341 (patch)
tree41b87360400ae0cd01d8afd0ab68358eeb4ff93c
parent5dc8fad71d2bb1896f022ee2cb500762e25e67d1 (diff)
downloadembedlog-ca5eece1b1a074f824962065f006361e55ec4341.tar.gz
embedlog-ca5eece1b1a074f824962065f006361e55ec4341.tar.bz2
embedlog-ca5eece1b1a074f824962065f006361e55ec4341.zip
src: add "public api" comment to public functions.
All functions that are part of library public API, have now comment stating that fact. It's easier now to know if function can be called by external user or not. Signed-off-by: Michał Łyszczek <michal.lyszczek@bofc.pl>
-rw-r--r--src/el-flush.c4
-rw-r--r--src/el-options.c18
-rw-r--r--src/el-pbinary.c4
-rw-r--r--src/el-perror.c4
-rw-r--r--src/el-pmemory.c8
-rw-r--r--src/el-print.c8
-rw-r--r--src/el-puts.c4
7 files changed, 25 insertions, 25 deletions
diff --git a/src/el-flush.c b/src/el-flush.c
index 7757af5..18a4973 100644
--- a/src/el-flush.c
+++ b/src/el-flush.c
@@ -45,7 +45,7 @@
========================================================================== */
-int el_flush
+/* public api */ int el_flush
(
void
)
@@ -59,7 +59,7 @@ int el_flush
========================================================================== */
-int el_oflush
+/* public api */ int el_oflush
(
struct el *el /* options defining printing style */
)
diff --git a/src/el-options.c b/src/el-options.c
index 7d2efe7..78666dd 100644
--- a/src/el-options.c
+++ b/src/el-options.c
@@ -559,7 +559,7 @@ static int el_vooption
========================================================================== */
-int el_init
+/* public api */ int el_init
(
void
)
@@ -576,7 +576,7 @@ int el_init
========================================================================== */
-int el_oinit
+/* public api */ int el_oinit
(
struct el *el /* el object */
)
@@ -611,7 +611,7 @@ int el_oinit
========================================================================== */
-struct el *el_new
+/* public api */ struct el *el_new
(
void
)
@@ -637,7 +637,7 @@ struct el *el_new
========================================================================== */
-int el_cleanup
+/* public api */ int el_cleanup
(
void
)
@@ -655,7 +655,7 @@ int el_cleanup
========================================================================== */
-int el_ocleanup
+/* public api */ int el_ocleanup
(
struct el *el /* el object */
)
@@ -684,7 +684,7 @@ int el_ocleanup
========================================================================== */
-int el_destroy
+/* public api */ int el_destroy
(
struct el *el /* el object */
)
@@ -720,7 +720,7 @@ int el_log_allowed
========================================================================== */
-int el_option
+/* public api */ int el_option
(
int option, /* option to set */
... /* option value */
@@ -743,7 +743,7 @@ int el_option
========================================================================== */
-int el_ooption
+/* public api */ int el_ooption
(
struct el *el, /* el object to set option to */
int option, /* option to set */
@@ -769,7 +769,7 @@ int el_ooption
========================================================================== */
-const struct el *el_get_el
+/* public api */ const struct el *el_get_el
(
void
)
diff --git a/src/el-pbinary.c b/src/el-pbinary.c
index 0d24343..4f26012 100644
--- a/src/el-pbinary.c
+++ b/src/el-pbinary.c
@@ -161,7 +161,7 @@ static size_t el_flags
========================================================================== */
-int el_opbinary
+/* public api */ int el_opbinary
(
enum el_level level, /* log severity level */
struct el *el, /* el object with info how to print */
@@ -234,7 +234,7 @@ int el_opbinary
========================================================================== */
-int el_pbinary
+/* public api */ int el_pbinary
(
enum el_level level, /* log severity level */
diff --git a/src/el-perror.c b/src/el-perror.c
index 5147d9a..dd40823 100644
--- a/src/el-perror.c
+++ b/src/el-perror.c
@@ -101,7 +101,7 @@ static int el_ovperror
========================================================================== */
-int el_perror
+/* public api */ int el_perror
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
@@ -129,7 +129,7 @@ int el_perror
========================================================================== */
-int el_operror
+/* public api */ int el_operror
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed*/
diff --git a/src/el-pmemory.c b/src/el-pmemory.c
index 3225cdb..ba07a84 100644
--- a/src/el-pmemory.c
+++ b/src/el-pmemory.c
@@ -271,7 +271,7 @@ static int el_pmem
========================================================================== */
-int el_opmemory_table
+/* public api */ int el_opmemory_table
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
@@ -291,7 +291,7 @@ int el_opmemory_table
========================================================================== */
-int el_pmemory_table
+/* public api */ int el_pmemory_table
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
@@ -309,7 +309,7 @@ int el_pmemory_table
========================================================================== */
-int el_opmemory
+/* public api */ int el_opmemory
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
@@ -329,7 +329,7 @@ int el_opmemory
========================================================================== */
-int el_pmemory
+/* public api */ int el_pmemory
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
diff --git a/src/el-print.c b/src/el-print.c
index 94e0b3a..9154d06 100644
--- a/src/el-print.c
+++ b/src/el-print.c
@@ -340,7 +340,7 @@ static size_t el_funcinfo
========================================================================== */
-int el_print
+/* public api */ int el_print
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
@@ -368,7 +368,7 @@ int el_print
========================================================================== */
-int el_oprint
+/* public api */ int el_oprint
(
const char *file, /* file name to print in log */
size_t num, /* line number to print in log */
@@ -397,7 +397,7 @@ int el_oprint
========================================================================== */
-int el_vprint
+/* public api */ int el_vprint
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
@@ -427,7 +427,7 @@ int el_vprint
========================================================================== */
-int el_ovprint
+/* public api */ int el_ovprint
(
const char *file, /* file name to print in log */
size_t num, /* line number to print in log */
diff --git a/src/el-puts.c b/src/el-puts.c
index 0294cb2..742b2bc 100644
--- a/src/el-puts.c
+++ b/src/el-puts.c
@@ -49,7 +49,7 @@
========================================================================== */
-int el_puts
+/* public api */ int el_puts
(
const char *s /* string to put into output */
)
@@ -137,7 +137,7 @@ int el_oputs
========================================================================== */
-int el_putb
+/* public api */ int el_putb
(
const void *mem, /* memory location to 'print' */
size_t mlen /* size of the mem buffer */