Fix mongoose docs generation

PUBLISHED_FROM=331821dcd1f7dc8a94581cd8a9b51aa00a89fddc
This commit is contained in:
Dmitry Frank committed 2018-02-03 01:20:48 +02:00
1 parent ab000c684a
commit 3eb4eb8074
166 files changed
+3125

No files matched your search

+20
View File
@@ -0,0 +1,20 @@
---
title: "Memory Buffers"
symbol_kind: "intro"
decl_name: "mbuf.h"
items:
- { name: mbuf_append.md }
- { name: mbuf_free.md }
- { name: mbuf_init.md }
- { name: mbuf_insert.md }
- { name: mbuf_remove.md }
- { name: mbuf_resize.md }
- { name: mbuf_trim.md }
- { name: struct_mbuf.md }
---
Mbufs are mutable/growing memory buffers, like C++ strings.
Mbuf can append data to the end of a buffer or insert data into arbitrary
position in the middle of a buffer. The buffer grows automatically when
needed.
+12
View File
@@ -0,0 +1,12 @@
---
title: "mbuf_append()"
decl_name: "mbuf_append"
symbol_kind: "func"
signature: |
size_t mbuf_append(struct mbuf *, const void *data, size_t data_size);
---
Appends data to the Mbuf.
Returns the number of bytes appended or 0 if out of memory.
+10
View File
@@ -0,0 +1,10 @@
---
title: "mbuf_free()"
decl_name: "mbuf_free"
symbol_kind: "func"
signature: |
void mbuf_free(struct mbuf *);
---
Frees the space allocated for the mbuffer and resets the mbuf structure.
+11
View File
@@ -0,0 +1,11 @@
---
title: "mbuf_init()"
decl_name: "mbuf_init"
symbol_kind: "func"
signature: |
void mbuf_init(struct mbuf *, size_t initial_capacity);
---
Initialises an Mbuf.
`initial_capacity` specifies the initial capacity of the mbuf.
+14
View File
@@ -0,0 +1,14 @@
---
title: "mbuf_insert()"
decl_name: "mbuf_insert"
symbol_kind: "func"
signature: |
size_t mbuf_insert(struct mbuf *, size_t, const void *, size_t);
---
Inserts data at a specified offset in the Mbuf.
Existing data will be shifted forwards and the buffer will
be grown if necessary.
Returns the number of bytes inserted.
+10
View File
@@ -0,0 +1,10 @@
---
title: "mbuf_remove()"
decl_name: "mbuf_remove"
symbol_kind: "func"
signature: |
void mbuf_remove(struct mbuf *, size_t data_size);
---
Removes `data_size` bytes from the beginning of the buffer.
+13
View File
@@ -0,0 +1,13 @@
---
title: "mbuf_resize()"
decl_name: "mbuf_resize"
symbol_kind: "func"
signature: |
void mbuf_resize(struct mbuf *, size_t new_size);
---
Resizes an Mbuf.
If `new_size` is smaller than buffer's `len`, the
resize is not performed.
+10
View File
@@ -0,0 +1,10 @@
---
title: "mbuf_trim()"
decl_name: "mbuf_trim"
symbol_kind: "func"
signature: |
void mbuf_trim(struct mbuf *);
---
Shrinks an Mbuf by resizing its `size` to `len`.
+14
View File
@@ -0,0 +1,14 @@
---
title: "struct mbuf"
decl_name: "struct mbuf"
symbol_kind: "struct"
signature: |
struct mbuf {
char *buf; /* Buffer pointer */
size_t len; /* Data length. Data is located between offset 0 and len. */
size_t size; /* Buffer size allocated by realloc(1). Must be >= len */
};
---
Memory buffer descriptor