OpenXRay/xray-16

Documentation

Open

#207 opened on May 25, 2018

View on GitHub
 (4 comments) (3 reactions) (0 assignees)C++ (519 forks)auto 404
Code QualityDocumentationHelp wantedInfrastructure

Repository metrics

Stars
 (3,524 stars)
PR merge metrics
 (PR metrics pending)

Description

We should document all the engine's code.

I suggest to use Doxygen, which is widely used. Other alternatives, maybe?

Contributor guide

Research direction
Research Doxygen configuration for C++ projects and propose a documentation generation setup for the engine codebase.
Tech stack
cpp
Domain
game devdocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80