Imagine-Programming / Imagine-Programming/hindsight

[documentation] generate a Wiki from the XML comments in code.

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

Description

Currently, the code is thoroughly documented through XML comment blocks. These XML comment blocks are not extremely well supported for C++ in Visual Studio, but they do describe all classes, methods and relevant members with references to other classes, methods and relevant members.

The next step is to generate some form of wiki from those XML blocks, making the code easier to navigate and understand for people that are new to Windows API programming, the project and/or C++.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue points to XML comment blocks throughout the C++ code, but names no files, generator, wiki format, or acceptance criteria. Start by reviewing the documented classes, methods, members, and cross-references, then determine the wiki output and generation approach. Done means the XML comments are transformed into a navigable wiki that helps newcomers understand the project and Windows API programming.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.