Skip to content

Commit ea16af3

Browse files
committed
Doc: Adjust output for \techpreview macro
The output generated for entities using the \preliminary QDoc command can now be customized via documentation configuration variables. Repurpose \preliminary for marking entities as being in 'technology preview' state, and turn the \techpreview macro into a direct alias for \preliminary. Task-number: QTBUG-142344 Change-Id: Icb80d6b67514c1e6ba594bbaeb20b6a06e3154d3 Reviewed-by: Topi Reinio <topi.reinio@qt.io>
1 parent c2ac3bf commit ea16af3

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

doc/global/macros.qdocconf

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -174,10 +174,11 @@ macro.cmakepropertyiosonly = "\\note This property is used only if targeting iOS
174174
macro.cmakevariableiosonly = "\\note This variable is used only if targeting iOS."
175175

176176
macro.qtpolicydeprecatedbehavior = "\\note The \\c{OLD} behavior of a policy is deprecated, and may be removed in the future."
177-
#Appends the tech preview link to the brief sentence and adds to tech_preview
178-
#group.
179-
#Must be placed directly under a \brief command
180-
macro.techpreview = "(Technical preview)\n\n\\meta status {Technical preview}\n\\ingroup tech_preview\n"
177+
178+
# Set preliminary status as 'Technology preview'
179+
preliminary = "Technology preview"
180+
preliminary.description = "This \1 is in technology preview and is subject to change."
181+
macro.techpreview = \\preliminary
181182

182183
include(grid.qdocconf)
183184
include(cpp-doc-macros.qdocconf)

0 commit comments

Comments
 (0)