Skip to content

Conversation

miri64
Copy link
Member

@miri64 miri64 commented Nov 17, 2015

Moves the documentation for packages to doxygen.

@miri64 miri64 added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: doc Area: Documentation labels Nov 17, 2015
@miri64 miri64 added this to the Release 2015.12 milestone Nov 17, 2015
@OlegHahm
Copy link
Member

Didn't you say that doxygen can parse markdown as well?

@miri64
Copy link
Member Author

miri64 commented Nov 17, 2015

It can parse it, yes. But it generates automatically pages for every new markdown file (named the name of the markdown file). We don't want this here, but just a module documentation.

In detail: when adding a doc.md instead of a doc.txt (and adding doc.md to the FILE_PATTERN config var of doxygen), the page tree of doxygen looks like:

▼ RIOT Documentation
   doc                       # containing an empty page
   RIOT in a nutshell
   Contribute to RIOT
   The quickest start
   Structure
   Todo List
 ▶ Deprecated List
 ▼ Modules
  ▶ Boards
  ▶ CPU
  ▶ Drivers
  ▶ Kernel
  ▶ Networking
    Packages
  ▶ System
▶ Data Structures
▶ Files

I don't want this empty doc page ;-)

@OlegHahm
Copy link
Member

I see.

@miri64
Copy link
Member Author

miri64 commented Nov 18, 2015

I saw this, too. But since PRs like #4285 will introduce further pages, I thought it to be less consistent. Additionally, the doxygen markdown still requires labels to be of any use to doxygen (Sub-sections in page tree, TOC, and ability to reference sections or pages from within doxygen). This isn't parsed however by GitHub properly (as well as the @ref references to other pages). Have a look at the main page on GitHub vs the intended result to see what I mean.

@miri64
Copy link
Member Author

miri64 commented Dec 8, 2015

Rebased to current master

@miri64 miri64 mentioned this pull request Dec 8, 2015
@@ -758,6 +758,7 @@ INPUT = ../../doc.txt \
../../cpu \
../../boards \
../../drivers \
../../pkg \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

duplicate line

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed and squashed immediately

@miri64 miri64 added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Dec 9, 2015
*
* ~~~~~~~~ {.mk}
* USEPKG += <pkg_name>
* INCLUDE += $(RIOTBASE)/pkg/<pkg_name>/...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe INCLUDE += $(RIOTBASE)/pkg/<pkg_name>/<path to include directory> could be even more explicit, or is that overkill?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's overkill. Also the pkg directory might be the include directory.

@OlegHahm
Copy link
Member

ACK and go!

OlegHahm added a commit that referenced this pull request Dec 18, 2015
doc: move pkg/PORTING.md and pkg/USING.md to doxygen
@OlegHahm OlegHahm merged commit f22cac2 into RIOT-OS:master Dec 18, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants