Skip to content

Commit 0d345b0

Browse files
committed
Documentation updates
1 parent 0ea731c commit 0d345b0

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ DOXYFILE_ENCODING = UTF-8
4242
# title of most generated pages and in a few other places.
4343
# The default value is: My Project.
4444

45-
PROJECT_NAME = Delegates
45+
PROJECT_NAME = DelegateMQ
4646

4747
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
4848
# could be handy for archiving the generated documentation or if some version

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The DelegateMQ library asynchronous features differ from `std::async` in that th
6565
6666
DelegateMQ uses an external thread, transport, and serializer, all of which are based on simple, well-defined interfaces.
6767
68-
<img src="docs/LayerDiagram.jpg" alt="DelegateMQ Layer Diagram" style="width:60%;"><br>
68+
<img src="docs/LayerDiagram.jpg" alt="DelegateMQ Layer Diagram" style="width:70%;"><br>
6969
*DelegateMQ Layer Diagram*
7070
7171

docs/DETAILS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ include("${CMAKE_SOURCE_DIR}/../../../../src/delegate-mq/DelegateMQ.cmake")
159159

160160
Update `External.cmake` external library paths.
161161

162-
Add `DMQ_PREDEF_SOURCES` to your sources If using the predefined supporting DelegateMQ classes (e.g. `Thread`, `Serialize`, ...).
162+
Add `DMQ_PREDEF_SOURCES` to your sources if using the predefined supporting DelegateMQ classes (e.g. `Thread`, `Serialize`, ...).
163163

164164
```
165165
# Collect DelegateMQ predef source files
@@ -699,7 +699,7 @@ delegateRemote.Invoke(recv_stream);
699699
```
700700
## Error Handling
701701

702-
The DelegateMQ library uses dynamic memory to send asynchronous delegate messages to the target thread. By default, out-of-memory failures throw a `std::bad_alloc` exception. Optionally, if `USE_ASSERTS` is defined, exceptions are not thrown, and an assert is triggered instead. See `DelegateOpt.h` for more details.
702+
The DelegateMQ library uses dynamic memory to send asynchronous delegate messages to the target thread. By default, out-of-memory failures throw a `std::bad_alloc` exception. Optionally, if `DMQ_ASSERTS` is defined, exceptions are not thrown, and an assert is triggered instead. See `DelegateOpt.h` for more details.
703703

704704
Remote delegate error handling is captured by registering a callback with `SetErrorHandler()`.
705705

@@ -791,7 +791,7 @@ The `DelegateMQ` library external dependencies are based upon on the intended us
791791

792792
## Fixed-Block Memory Allocator
793793

794-
The DelegateMQ library optionally uses a fixed-block memory allocator when `USE_ALLOCATOR` is defined. See `DelegateOpt.h` for more details. The allocator design is available in the [stl_allocator](https://github.com/endurodave/stl_allocator) repository.
794+
The DelegateMQ library optionally uses a fixed-block memory allocator when `DMQ_ALLOCATOR` is defined. See `DelegateOpt.h` for more details. The allocator design is available in the [stl_allocator](https://github.com/endurodave/stl_allocator) repository.
795795

796796
`std::function` used within class `DelegateFunction` may use the heap under certain conditions. Implement a custom `xfunction` similar to the `xlist` concept within `xlist.h` using the `xallocator` fixed-block allocator if deemed necessary.
797797

0 commit comments

Comments
 (0)