Skip to content

Commit

Permalink
Update doxygen mainpage
Browse files Browse the repository at this point in the history
  • Loading branch information
thomas-bc committed Nov 21, 2023
1 parent fce87fa commit 9663852
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/doxygen/mainpage.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,38 @@
\mainpage

This is the F´ automatically generated documentation. The below guides represent the software
description documentation (SDD) for the F´ components. Included in the Namespace and Classes sections
is the documentation of the C++ code.
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.


\page Fw Fw Components, Ports, and Classes

\subpage 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.


\page Os Os Components Ports and Classes
\subpage 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.


\page Svc Svc Components, Ports, and Classes
\subpage 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.


\page Drv Drv Components and Classes
\subpage 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.


\page Utils Utils Classes
\subpage Utils Utils Classes

The Utils package provides classes for general applications in F´ projects. These classes are for
a variety of purposes.
Expand Down

0 comments on commit 9663852

Please sign in to comment.