Add back subindex

nasa · Nov 27, 2023 · 39bcb99 · 39bcb99
1 parent 4eee030
commit 39bcb99
Show file tree

Hide file tree

Showing 5 changed files with 140 additions and 10 deletions.
diff --git a/Svc/BufferAccumulator/docs/BufferAccumulator.md b/Svc/BufferAccumulator/docs/BufferAccumulator.md
@@ -1,4 +1,4 @@
-\page BufferAccumulatorComponent Svc::BufferAccumulator Component
+\page SvcBufferAccumulatorComponent Svc::BufferAccumulator Component
 # BufferAccumulator Component Dictionary
 
 

diff --git a/Svc/PassiveRateGroup/docs/sdd.md b/Svc/PassiveRateGroup/docs/sdd.md
@@ -1,4 +1,4 @@
-\page RateGroupDriverComponent Svc::RateGroupDriver Component
+\page SvcPassiveRateGroupComponent Svc::PassiveRateGroup Component
 # RateGroupDriver Component
 
 ## 1. Introduction

diff --git a/Svc/SystemResources/docs/sdd.md b/Svc/SystemResources/docs/sdd.md
@@ -1,4 +1,4 @@
-\page SystemResourcesComponent Svc::SystemResources Component
+\page SvcSystemResourcesComponent Svc::SystemResources Component
 # SystemResources Component
 
 The system resources component downlinks information about the running F´ system. This information includes:

diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile
@@ -918,7 +918,7 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       = */test/* */GTest/* */build-*/* */cmake/* */docs/v*.* */README.md */docs/_* 
+EXCLUDE_PATTERNS       = */test/* */GTest/* */build-*/* */cmake/* */docs/v*.* */docs/_* 
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the

diff --git a/docs/doxygen/mainpage.md b/docs/doxygen/mainpage.md
@@ -2,38 +2,168 @@
 
 This is the F´ automatically generated documentation. 
 The sidebar links point to the software description documentation (SDD) for the F´ components. 
-The below guides, as well as the Namespace and Classes sections, link to the documentation of the C++ code. 
+The Namespace and Classes sections link to the documentation of the C++ code. 
 
 
 
-\subpage 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
 are built.  Finally, of specific interest is Fw::Types providing the cored types in the system.
 
+\subpage FwBufferSerializableBufferGetBufferSend
 
-\subpage Os Os Components Ports and Classes
+\subpage FwCmdFwCmdResponseFwCmdReg
+
+\subpage FwComPort
+
+\subpage FwFilePacketClasses
+
+\subpage FwLogLogText
+
+\subpage FwObjClasses
+
+\subpage FwPortClasses
+
+\subpage FwPrmGetPrmSet
+
+\subpage FwTimePort
+
+\subpage FwTlmPort
+
+\subpage FwTypeClasses
+
+
+\page Os Os Components Ports and Classes
 
 The Os package is an operating system abstraction layer. It provides basic Os system functions to
 F´. This includes things like Mutexes, Queues, Tasks, and a File System.
 
+\subpage OsQueue
 
-\subpage 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.
 
+\subpage SvcAMPCSSequenceClass
+
+\subpage SvcActiveLoggerComponent
+
+\subpage SvcActiveRateGroupComponent
+
+\subpage SvcActiveTextLoggerComponent
+
+\subpage SvcAssertFatalAdapterComponent
+
+\subpage SvcBufferAccumulatorComponent
+
+\subpage SvcBufferManagerComponent
+
+\subpage SvcBufferRepeaterComponent
+
+\subpage SvcCmdDispatcherComponent
+
+\subpage SvcCmdSequencerComponent
+
+\subpage SvcCmdSequencerFormats
+
+\subpage SvcCmdSplitter
+
+\subpage SvcComLoggerComponent
+
+\subpage SvcComQueueComponent
+
+\subpage SvcComSplitterComponent
+
+\subpage SvcComStubComponent
+
+\subpage SvcDeframerComponent
+
+\subpage SvcFatalHandlerComponent
+
+\subpage SvcFatalPort
+
+\subpage SvcFileDownlinkComponent
+
+\subpage SvcFileManagerComponent
+
+\subpage SvcFileUplinkComponent
 
-\subpage Drv Drv Components and Classes
+\subpage SvcFramerComponent
+
+\subpage SvcFramingProtocol
+
+\subpage SvcGenericHubComponent
+
+\subpage SvcHealthComponent
+
+\subpage SvcPassiveConsoleTextLoggerComponent
+
+\subpage SvcPingPort
+
+\subpage SvcPolyDbComponent
+
+\subpage SvcPolyPort
+
+\subpage SvcPosixTime
+
+\subpage SvcPrmDbComponent
+
+\subpage SvcPassiveRateGroupComponent
+
+\subpage SvcRateGroupDriverComponent
+
+\subpage SvcSchedPort
+
+\subpage SvcStaticMemoryComponent
+
+\subpage SvcSystemResourcesComponent
+
+\subpage SvcTlmChanComponent
+
+\subpage SvcTlmPacketizerComponent
+
+\subpage SvcTlmPacketizerComponentDictionary
+
+\subpage SvcWatchDogPort
+
+
+\page Drv Drv Components and Classes
 
 The Drv package provides drivers to support various hardware functions for F´. These drivers 
 include a sample block driver component as well a various drivers that support Linux hardware
 functions.
 
+\subpage DrvBlockDriverComponent
+
+\subpage DrvByteStreamDriverModel
+
+\subpage DrvIp
+
+\subpage DrvStreamCrossover
+
+\subpage DrvTcpClient
 
-\subpage Utils Utils Classes
+\subpage DrvTcpServer
+
+\subpage DrvUdp
+
+
+
+\page Utils Utils Classes
 
 The Utils package provides classes for general applications in F´ projects. These classes are for
 a variety of purposes.
 
+\subpage UtilsHashClass
+
+\subpage UtilsLockGuardClass
+
+\subpage UtilsRateLimiterClass
+
+\subpage UtilsTokenBucketClass
+
+\subpage UtilsTypesLibrary