Fix mainpage pages and move references into respective subpages (#1423)

This commit is contained in:
Carlos Domani 2022-04-29 00:25:20 +00:00 committed by GitHub
parent 8176bcdc10
commit b85a34b3f7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 51 additions and 29 deletions

View File

@ -1,5 +1,5 @@
\page ByteStreamDriverModel Byte Stream Driver Model
# Byte Stream Driver Model
\page DrvByteStreamDriverModel Drv::ByteStreamDriverModel Byte Stream Driver Model
# Drv::ByteStreamDriverModel Byte Stream Driver Model
The byte stream driver is a generic model for drivers implementing a "stream of bytes" interface. Typically these
drivers operate with an outgoing stream and an incoming stream. The outgoing stream is represented by the "send" port

View File

@ -1,4 +1,4 @@
\page DrvIp IPv4 Socket Implementations
\page DrvIp Drv::Ip IPv4 Socket Implementations
# Drv::Ip IPv4 Socket Implementations
This package contains utility classes to help interact with standard IPv4 (Berkley) sockets. These classes implement the

View File

@ -1,5 +1,5 @@
\page DrvTcpClient Tcp Client Component
# Drv::TcpClient Tcp Client Component
\page DrvTcpClient Drv::TcpClient Component
# Drv::TcpClient TCP Client Component
The TCP client component bridges the byte stream driver model interface to a remote TCP server to which this tcp client
connects and sends/receives bytes. It implements the callback formation (shown below) using a thread to receive data

View File

@ -1,4 +1,4 @@
\page DrvTcpServer Tcp Server Component
\page DrvTcpServer Drv::TcpServer Component
# Drv::TcpServer Tcp Server Component
The TCP server component bridges the byte stream driver model interface to a remote TCP client to which this tcp server

View File

@ -1,3 +1,4 @@
\page DrvUartFramerComponent Drv::UartFramer Component
# Drv::UartFramer UART Framer Component
The UART Framer Component is used to bridge the [Framer](../../Svc/Framer/docs/sdd.md) and

View File

@ -1,5 +1,5 @@
\page DrvUdp Udp Component
# Drv::Udp Udp Component
\page DrvUdp Drv::Udp Component
# Drv::Udp UDP Component
The UDP client component bridges the byte stream driver model interface to a remote UDP port to which this udp component
sends/receives bytes. It implements the callback formation (shown below) using a thread to receive data and producing

View File

@ -1,5 +1,4 @@
\page SvcDeframer Deframer Component
\page SvcDeframerComponent Svc::Deframer Component
# Svc::Deframer (Passive Component)
## 1. Introduction

View File

@ -1,4 +1,4 @@
\page SvcFramer Framer Component
\page SvcFramerComponent Svc::Framer Component
# Svc::Framer Framer Component
The Framer component is used to frame packets for downlink. It translates between the service layer (typically TlmChan, ActiveLogger, and FileDownlink) and the driver layer (Drv), where service typically deals with F´ types and the driver layer deals in streams of bytes. Framer serializes the F´ types into a stream of bytes and adds header/footer information to ensure transmission integrity. As an argument to `setup()` function Framer accepts a reference to a `FramingProtocol` to do the actual header/data/footer serialization. Users may substitute the framing protocol without changing the F´ topology hook-ups.

View File

@ -1,4 +1,4 @@
\page SvcFramingProtocol FramingProtocol
\page SvcFramingProtocol Svc::FramingProtocol Protocol
# Svc::FramingProtocol Library
The `FramingProtocol` library defines the interfaces to the

View File

@ -1,4 +1,4 @@
\page SvcGenericHub Generic Hub Component
\page SvcGenericHubComponent Svc::GenericHub Component
# Svc::GenericHub Generic Hub Component
The Generic Hub component is an implementation of the F´ [hub pattern](https://nasa.github.io/fprime/UsersGuide/best/hub-pattern.html).

View File

@ -1,4 +1,4 @@
\page SvcGenericRepeater Generic Repeater Component
\page SvcGenericRepeaterComponent Svc::GenericRepeater Component
# Svc::GenericRepeater Generic Repeater Component
The GenericRepeater component is designed to take in a port and repeat it to the output multiple times. GenericRepeater is

View File

@ -1,5 +1,5 @@
\page SvcStaticMemory Static Memory Component
# Svc::StaticMemory Static Memory Component
\page SvcStaticMemoryComponent Svc::StaticMemory Component
# Svc::StaticMemory Component
The StaticMemory component is a drop in replacement for Svc::BufferManager that allocates memory out of a static pool of
memory. This allows for allocations of known sizes and usage patterns to avoid extra dynamic memory complexity at the
@ -25,7 +25,7 @@ StaticMemoryAllocations = 4
The size of each memory segment is set in `StaticMemoryConfig.hpp` as shown below.
```c++
STATIC_MEMORY_ALLOCATION_SIZE = 2048
STATIC_MEMORY_ALLOCATION_SIZE = 2048
```
This means the total memory used is `StaticMemoryAllocations` * `STATIC_MEMORY_ALLOCATION_SIZE` bytes.

View File

@ -1,6 +1,5 @@
<title>TlmPacketizer Component Dictionary</title>
# TlmPacketizer Component Dictionary
\page SvcTlmPacketizerComponentDictionary Svc::TlmPacketizer Component Dictionary
# Svc::TlmPacketizer Component Dictionary
## Command List

View File

@ -1,5 +1,5 @@
<title>TlmPacketizer Component SDD</title>
# TlmPacketizer Component
\page SvcTlmPacketizerComponent Svc::TlmPacketizer Component
# Svc::TlmPacketizer Component
## 1. Introduction

View File

@ -5,7 +5,7 @@ description documentation (SDD) for the F´ components. Included in the Namespac
is the documentation of the C++ code.
\page Fw Fw Components Ports and Classes
\page Fw Fw Components, Ports, and Classes
The Fw package provides the core classes, components, and ports to support F´. These classes allow
for the core framework operation. In addition, these include the base classes on which components
@ -42,7 +42,7 @@ F´. This includes things like Mutexes, Queues, Tasks, and a File System.
\subpage OsQueue
\page Svc Svc Components Ports and Classes
\page Svc Svc Components, Ports, and Classes
The Svc package provides standard components to support greater F´ applications. This includes
command and data handling components used for more complete applications.
@ -51,6 +51,8 @@ command and data handling components used for more complete applications.
\subpage SvcActiveLoggerComponent
\subpage SvcActiveRateGroupComponent
\subpage SvcActiveTextLoggerComponent
\subpage SvcAssertFatalAdapterComponent
@ -61,9 +63,7 @@ command and data handling components used for more complete applications.
\subpage SvcCmdSequencerComponent
\subpage SvcCmdSequencerFormats
\subpage SvcComLoggerComponent
\subpage SvcDeframerComponent
\subpage SvcFatalHandlerComponent
@ -75,6 +75,14 @@ command and data handling components used for more complete applications.
\subpage SvcFileUplinkComponent
\subpage SvcFramerComponent
\subpage SvcFramingProtocol
\subpage SvcGenericHubComponent
\subpage SvcGenericRepeaterComponent
\subpage SvcHealthComponent
\subpage SvcLinuxTimeComponent
@ -91,12 +99,16 @@ command and data handling components used for more complete applications.
\subpage SvcRateGroupDriverComponent
\subpage SvcRateGroupDriverComponent
\subpage SvcSchedPort
\subpage SvcStaticMemoryComponent
\subpage SvcTlmChanComponent
\subpage SvcTlmPacketizerComponent
\subpage SvcTlmPacketizerComponentDictionary
\subpage SvcWatchDogPort
@ -108,6 +120,17 @@ functions.
\subpage DrvBlockDriverComponent
\subpage DrvByteStreamDriverModel
\subpage DrvIp
\subpage DrvTcpClient
\subpage DrvTcpServer
\subpage DrvUartFramerComponent
\subpage DrvUdp
\page Utils Utils Classes