xref: /aosp_15_r20/external/stardoc/CHANGELOG.md (revision b2fa42943c124aa9c7163734493fc7a7559681cf)
1*b2fa4294SXin Li## Release 0.5.3
2*b2fa4294SXin Li
3*b2fa4294SXin LiBugfix release: fixes angle bracket escaping and a crash on labels with `@@`
4*b2fa4294SXin Li
5*b2fa4294SXin Li**Contributors**
6*b2fa4294SXin Li
7*b2fa4294SXin LiAlexandre Rostovtsev, Jon Shea
8*b2fa4294SXin Li
9*b2fa4294SXin Li## Release 0.5.2
10*b2fa4294SXin Li
11*b2fa4294SXin LiBugfix release: fixes crash with `config_common.toolchain_type`.
12*b2fa4294SXin Li
13*b2fa4294SXin Li**Contributors**
14*b2fa4294SXin Li
15*b2fa4294SXin LiAlexandre Rostovtsev, Keith Smiley
16*b2fa4294SXin Li
17*b2fa4294SXin Li## Release 0.5.1
18*b2fa4294SXin Li
19*b2fa4294SXin LiBugfix release: minor fixes, including a fix for build failure due to missing zlib version.
20*b2fa4294SXin Li
21*b2fa4294SXin Li**Contributors**
22*b2fa4294SXin Li
23*b2fa4294SXin Liaiuto, Alexandre Rostovtsev, Brian Silverman, Casey, Xùdōng Yáng
24*b2fa4294SXin Li
25*b2fa4294SXin Li## Release 0.5.0
26*b2fa4294SXin Li
27*b2fa4294SXin LiThis release includes many fixes for Stardoc's markdown output, plus:
28*b2fa4294SXin Li
29*b2fa4294SXin Li**New Features**
30*b2fa4294SXin Li
31*b2fa4294SXin Li-   Raw protobuf output via `format = "proto"` (#20)
32*b2fa4294SXin Li-   Stardoc now outputs documentation for macro returns and deprecations (#75)
33*b2fa4294SXin Li    as well as module (file) docstrings (#100)
34*b2fa4294SXin Li
35*b2fa4294SXin Li**Contributors**
36*b2fa4294SXin Li
37*b2fa4294SXin LiAlexandre Rostovtsev, Alex Eagle, Andrew Z Allen, Chris Rebert, c-parsons, Ivo
38*b2fa4294SXin LiList, Jon Brandvein, Laurent Le Brun, Max Vorobev, pbatg, Philipp Wollermann,
39*b2fa4294SXin LiSamuel Giddins, Thomas Van Lenten, Tiago Quelhas, Xùdōng Yáng, Yiting Wang
40*b2fa4294SXin Li
41*b2fa4294SXin Li## Release 0.4.0
42*b2fa4294SXin Li
43*b2fa4294SXin LiFirst release of **Stardoc** under the new repository location
44*b2fa4294SXin Li[bazelbuild/stardoc](https://github.com/bazelbuild/stardoc). Please use this
45*b2fa4294SXin Lirepository for future Stardoc releases instead of its old location. See
46*b2fa4294SXin Li[Getting Started](https://github.com/bazelbuild/stardoc/blob/4378e9b6bb2831de7143580594782f538f461180/docs/getting_started_stardoc.md)
47*b2fa4294SXin Lifor updated setup information.
48*b2fa4294SXin Li
49*b2fa4294SXin LiThere are **many** new features since the last release. A summary of major
50*b2fa4294SXin Lifeatures:
51*b2fa4294SXin Li
52*b2fa4294SXin Li-   Changed the default Stardoc output format to use pure-markdown tables
53*b2fa4294SXin Li    instead of HTML tables. This output format is fully compatible with markdown
54*b2fa4294SXin Li    formatting constructs. For example, use `**bold**` instead of `<b>bold</b>`.
55*b2fa4294SXin Li    The `<`. and `>` characters are escaped in this output format.
56*b2fa4294SXin Li-   Stardoc now supports custom formatting. See
57*b2fa4294SXin Li    [Custom Output documentation](https://github.com/bazelbuild/stardoc/blob/4378e9b6bb2831de7143580594782f538f461180/docs/advanced_stardoc_usage.md#custom-output)
58*b2fa4294SXin Li    for details.
59*b2fa4294SXin Li-   `aspect()` definitions are now documented by Stardoc.
60*b2fa4294SXin Li-   Module definitions (structs which combine series of functions in a
61*b2fa4294SXin Li    'namespace') are now documetned by Stardoc.
62*b2fa4294SXin Li-   Attribute default-value information is now included in output.
63*b2fa4294SXin Li
64*b2fa4294SXin Li**Huge Thanks to [kendalllaneee](https://github.com/kendalllaneee) and
65*b2fa4294SXin Li[blossommojekwu](https://github.com/blossommojekwu) for their work on many of
66*b2fa4294SXin Lithe features in this release.**
67*b2fa4294SXin Li
68