envoyproxy/envoy

Doxygen generation

Open

#579 opened on Mar 17, 2017

View on GitHub
 (22 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docshelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

We should add a "make doxygen" target and build with Doxygen. @mattklein123 already has some progress on this in docs/Doxyfile. It might also be worth investigating doing this in the CI and publishing.

@jamessynge

Contributor guide

Research direction
Examine the existing Doxyfile in docs/, create a make doxygen target, and set up CI to publish Doxygen generated docs.
Tech stack
cpp
Domain
documentationbuild systemci cd
Issue type
Feature
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.
Half day
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
GitC++Doxygen
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65