Re: Code snippets in documentation
Pavel Rappo via Concurrency-interest <[email protected]> Fri, 27 Nov 2020 20:48:15 +0000
| Newsgroups | gmane.comp.java.jsr.166-concurrency |
|---|---|
| Message-ID | <CAChcVu=m=01F49MLpzcL4ku=aUT4Jhu1OXATM9qsigUB7DLjZA@mail.gmail.com> |
Thanks, Doug. I hope one of these days JavaDoc will provide better support for code snippets. On Fri, Nov 27, 2020 at 5:42 PM Doug Lea via Concurrency-interest <[email protected]> wrote: > > Thanks very much! These are all helpful; a couple slightly arguable, but none make anything worse, so I'm committing them into our sources. We hope to soon integrate the largish backlog into CVS. For now you can see updated javadocs at: http://gee.cs.oswego.edu/dl/jsr166/dist/docs/ > > On 11/25/20 10:48 AM, Pavel Rappo via Concurrency-interest wrote: > > Hello, > > I'm currently looking into use of code snippets in doc comments in > various codebases, one of which is `java.util.concurrent.**`. While > looking at snippets there I found a few places that could be improved; > I created a patch with these improvements. > > This patch is merely a collection of suggestions that can be applied > selectively. I can provide the rationale for every change in that > patch, but for now, I'd just say that those changes improve uniformity > and correctness (where sensible). > > I used `cvs -q diff -U 2 --minimal > snippets.patch` to produce this > patch. If you prefer some other form, I can produce it too. > > Thanks, > -Pavel > > > _______________________________________________ > Concurrency-interest mailing list > [email protected] > http://cs.oswego.edu/mailman/listinfo/concurrency-interest > > _______________________________________________ > Concurrency-interest mailing list > [email protected] > http://cs.oswego.edu/mailman/listinfo/concurrency-interest _______________________________________________ Concurrency-interest mailing list [email protected] http://cs.oswego.edu/mailman/listinfo/concurrency-interest