Skip to content

Commit

Permalink
fixup developers manual structure
Browse files Browse the repository at this point in the history
deploy-docs
  • Loading branch information
Gunnar Andersson committed Sep 12, 2023
1 parent 1e73b3e commit d120389
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 4 deletions.
20 changes: 20 additions & 0 deletions docs/def-developers-manual.m.md.bak
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# IFEX Developers' Manual

This manual is useful primarily for implementation of new IFEX tools, but ocasionally also for people who develop software that uses artifacts that are generated to/from IFEX. Before reading the developers' manual, make sure you have read the [IFEX Core IDL specification](ifex-specification.md) and [FAQ](./FAQ.md) first.

!INCLUDE "generated-dev-toc.md"

!INCLUDE "static-ifex-type-mapping-howto.md"

# Mapping documents

By "mapping" we mean to describe how we may interpret and ultimately translate IFEX to or from another interface description environment, or a particular output format (computing environment, protocol, programming language, etc.). It can be such things as listing the "features" of IFEX and seeing how we may implement those features in the target environment (or the opposite direction, listing the features of the other environment and how IFEX can meet them).

General documents describe our general strategy for approaching mappings.

Individual documents describe particular target (or source) standards.

- [D-Bus](./static-mapping-dbus.md)

!INCLUDE "static-developer-generators.md"

Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# IFEX Developers' Manual

This manual is useful primarily for implementation of new IFEX tools, but occasionally also for people who develop software that uses artifacts that are generated to/from IFEX. Before reading the developers' manual, make sure you have read the [IFEX Core IDL specification](ifex-specification.md) and [FAQ](./FAQ.md) first.

!INCLUDE "generated-dev-toc.md"

!INCLUDE "static-ifex-type-mapping-howto.md"

# Mapping documents {#mapping-documents}
Expand Down
15 changes: 15 additions & 0 deletions docs/def-developers-manual.stage2.m.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# IFEX Developers' Manual

(C) 2022 - COVESA
(C) 2022-2023 - MBition GmbH
(C) 2023 - Novaspring AB

## Table of Contents

!INCLUDE "generated-developers-toc.md"

!INCLUDE "generated-developers-manual-content.md"

______________________________________________________________________

!INCLUDE "static-footer.md"

0 comments on commit d120389

Please sign in to comment.