From b85a34b3f7a20f483c75b70d3e18e4d34233227a Mon Sep 17 00:00:00 2001 From: Carlos Domani Date: Fri, 29 Apr 2022 00:25:20 +0000 Subject: [PATCH] Fix mainpage pages and move references into respective subpages (#1423) --- Drv/ByteStreamDriverModel/docs/sdd.md | 4 +-- Drv/Ip/docs/sdd.md | 2 +- Drv/TcpClient/docs/sdd.md | 4 +-- Drv/TcpServer/docs/sdd.md | 2 +- Drv/UartFramer/docs/sdd.md | 1 + Drv/Udp/docs/sdd.md | 4 +-- Svc/Deframer/docs/sdd.md | 3 +- Svc/Framer/docs/sdd.md | 2 +- Svc/FramingProtocol/docs/sdd.md | 2 +- Svc/GenericHub/docs/sdd.md | 2 +- Svc/GenericRepeater/docs/sdd.md | 2 +- Svc/StaticMemory/docs/sdd.md | 6 ++-- Svc/TlmPacketizer/docs/TlmPacketizer.md | 5 ++-- Svc/TlmPacketizer/docs/sdd.md | 4 +-- docs/doxygen/mainpage.md | 37 ++++++++++++++++++++----- 15 files changed, 51 insertions(+), 29 deletions(-) diff --git a/Drv/ByteStreamDriverModel/docs/sdd.md b/Drv/ByteStreamDriverModel/docs/sdd.md index 80f08578fe..a4db565059 100644 --- a/Drv/ByteStreamDriverModel/docs/sdd.md +++ b/Drv/ByteStreamDriverModel/docs/sdd.md @@ -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 diff --git a/Drv/Ip/docs/sdd.md b/Drv/Ip/docs/sdd.md index 3675f09950..16ba243299 100644 --- a/Drv/Ip/docs/sdd.md +++ b/Drv/Ip/docs/sdd.md @@ -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 diff --git a/Drv/TcpClient/docs/sdd.md b/Drv/TcpClient/docs/sdd.md index 7c4360ff6f..7fe2dd6739 100644 --- a/Drv/TcpClient/docs/sdd.md +++ b/Drv/TcpClient/docs/sdd.md @@ -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 diff --git a/Drv/TcpServer/docs/sdd.md b/Drv/TcpServer/docs/sdd.md index 0fd2a2e9e0..5ac4746814 100644 --- a/Drv/TcpServer/docs/sdd.md +++ b/Drv/TcpServer/docs/sdd.md @@ -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 diff --git a/Drv/UartFramer/docs/sdd.md b/Drv/UartFramer/docs/sdd.md index 5bbd990bc2..09a06df57e 100644 --- a/Drv/UartFramer/docs/sdd.md +++ b/Drv/UartFramer/docs/sdd.md @@ -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 diff --git a/Drv/Udp/docs/sdd.md b/Drv/Udp/docs/sdd.md index 6ed4cccbaf..caf2ed706e 100644 --- a/Drv/Udp/docs/sdd.md +++ b/Drv/Udp/docs/sdd.md @@ -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 diff --git a/Svc/Deframer/docs/sdd.md b/Svc/Deframer/docs/sdd.md index c9067ed3f6..bebee2c8d1 100644 --- a/Svc/Deframer/docs/sdd.md +++ b/Svc/Deframer/docs/sdd.md @@ -1,5 +1,4 @@ -\page SvcDeframer Deframer Component - +\page SvcDeframerComponent Svc::Deframer Component # Svc::Deframer (Passive Component) ## 1. Introduction diff --git a/Svc/Framer/docs/sdd.md b/Svc/Framer/docs/sdd.md index c8bfebcda5..128ac8e56c 100644 --- a/Svc/Framer/docs/sdd.md +++ b/Svc/Framer/docs/sdd.md @@ -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. diff --git a/Svc/FramingProtocol/docs/sdd.md b/Svc/FramingProtocol/docs/sdd.md index 1181d461a3..67183c18ad 100644 --- a/Svc/FramingProtocol/docs/sdd.md +++ b/Svc/FramingProtocol/docs/sdd.md @@ -1,4 +1,4 @@ -\page SvcFramingProtocol FramingProtocol +\page SvcFramingProtocol Svc::FramingProtocol Protocol # Svc::FramingProtocol Library The `FramingProtocol` library defines the interfaces to the diff --git a/Svc/GenericHub/docs/sdd.md b/Svc/GenericHub/docs/sdd.md index 7feff45c45..07fe96d654 100644 --- a/Svc/GenericHub/docs/sdd.md +++ b/Svc/GenericHub/docs/sdd.md @@ -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). diff --git a/Svc/GenericRepeater/docs/sdd.md b/Svc/GenericRepeater/docs/sdd.md index 9c9f3dea42..fe7106bb52 100644 --- a/Svc/GenericRepeater/docs/sdd.md +++ b/Svc/GenericRepeater/docs/sdd.md @@ -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 diff --git a/Svc/StaticMemory/docs/sdd.md b/Svc/StaticMemory/docs/sdd.md index dd6ba4f68d..86ce303545 100644 --- a/Svc/StaticMemory/docs/sdd.md +++ b/Svc/StaticMemory/docs/sdd.md @@ -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. diff --git a/Svc/TlmPacketizer/docs/TlmPacketizer.md b/Svc/TlmPacketizer/docs/TlmPacketizer.md index 7c0a4b2224..a75d47c0a4 100644 --- a/Svc/TlmPacketizer/docs/TlmPacketizer.md +++ b/Svc/TlmPacketizer/docs/TlmPacketizer.md @@ -1,6 +1,5 @@ -TlmPacketizer Component Dictionary -# TlmPacketizer Component Dictionary - +\page SvcTlmPacketizerComponentDictionary Svc::TlmPacketizer Component Dictionary +# Svc::TlmPacketizer Component Dictionary ## Command List diff --git a/Svc/TlmPacketizer/docs/sdd.md b/Svc/TlmPacketizer/docs/sdd.md index 081d976479..d23f5397cb 100644 --- a/Svc/TlmPacketizer/docs/sdd.md +++ b/Svc/TlmPacketizer/docs/sdd.md @@ -1,5 +1,5 @@ -TlmPacketizer Component SDD -# TlmPacketizer Component +\page SvcTlmPacketizerComponent Svc::TlmPacketizer Component +# Svc::TlmPacketizer Component ## 1. Introduction diff --git a/docs/doxygen/mainpage.md b/docs/doxygen/mainpage.md index 8a630fffd3..3c1d4f827f 100644 --- a/docs/doxygen/mainpage.md +++ b/docs/doxygen/mainpage.md @@ -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