gongminmin/KlayGE

Doxygen reference documents

Open

#40 opened on Jun 23, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (354 forks)github user discovery
docsenhancementhelp wanted

Repository metrics

Stars
 (2,170 stars)
PR merge metrics
 (PR metrics pending)

Description

Migrated from trac ticket 245.

Add Doxygen tags to all files, and use cmake to generate reference documents.

Contributor guide

Research direction
Familiarize yourself with Doxygen tags and how to integrate Doxygen with CMake. Look at existing documentation or examples in the repository to identify the style used.
Tech stack
cpp
Domain
game dev
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-2 days
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
C++DoxygenCMake
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85