use hyde as a clang-doc generator
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- cmake, cpp
- Ambito
- build-system, documentation
Direzione di ricerca
Inizia leggendo l’interfaccia clang-doc Generators.h e la documentazione di clang tooling Executor, quindi confrontale con la gestione attuale delle unità di traduzione da parte di Hyde. Determina se l’integrazione richiesta del generatore clang-doc o il percorso tramite un formatter esterno è fattibile; il lavoro è completo quando esistono un design di integrazione concordato e il supporto per il workflow indicato con più unità di traduzione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Hi!
A friend of mine recommended this tool and I would like to use it on my libraries. I really like the output format, easy to read and easy to document. My only issue is integrating the tool itself into my build systems and pipelines.
My main idea was to use the compile_commands.json provided by cmake, but it seems this tool is not ready to accept multiple translation units.
Is your feature request related to a problem? Please describe.
This tool aims to provide documentation based on clang ast. There is already a similar tool in the llvm environment itself, called clang-doc. Would it be possible to merge the efforts of this project into that one?
Describe the solution you'd like
In my opinion the easiest solution would be to merge this repository into the clang-doc as a generator format. This would require minimal modification in the clang-doc itself, but would require acceptance.
Describe alternatives you've considered
Another option would be to extend clang-doc to accept external formatters, such as hyde. This would require modification in the clang-doc as right now it is not ready for that. Would also require modification in the hyde code base, but it would be very similar to the other approach. ( Fit to the Generator interface. )
Additional context
One option would be to support multiple translation units via Executor, but it would cause duplicate effort because clang-doc already does this.
- Lingua principale
- C++
- Stelle
- 341
- Fork
- 45
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di adobe/hyde
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
-
Better owner managementAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 15/100
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
Issue simili
-
test(tools): two testkit cache tests fail unless GOCACHE and GOMODCACHE are in the environmentApertabacklog
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
EchoTools/nevr-runtime#2385 ·
I maintainer di solito rispondono entro 1 giorno
-
type:bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
tensorflow/tflite-micro#3995 ·
I maintainer di solito rispondono entro 1 giorno
-
CPU update 1.31xApertaspeed-report
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 75/100
mw00/project-maya#961 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
not for AI lovers
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
OSGeo/gdal#15515 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno