envoyproxy/envoy

Doxygen generation

Offen

#579 geöffnet am 17.03.2017

Auf GitHub ansehenContributor Guide
 (22 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
area/docshelp wanted

Repository-Metriken

Stars
 (27.997 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuchen Sie die vorhandene Doxyfile in docs/, erstellen Sie ein Make Doxygen Ziel und richten Sie CI ein, um die von Doxygen generierte Dokumentation zu veröffentlichen.
Tech Stack
cpp
Domain
documentationbuild systemci cd
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitC++Doxygen
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65