hasselmm / hasselmm/PropertyExperiment

Generate API documentation

Open
#28 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C++
Stars
4
Forks
1
PR merge metrics
No merged PRs in 30d

Description

The `NObject` type-system has some kind of inline-documenation. Extract it with some literate programming inspired tool like [Docco](https://ashkenas.com/docco/), or [Groc](https://github.com/nevir/groc).

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the inline documentation associated with the NObject type-system. Compare whether Docco or Groc can extract it, and consider the work complete when the project has a usable generated API documentation output.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.