drm: add documentation for tv connector state margins
Subsystems (2)
PATCH 1/1 drm: add documentation for tv connector state margins
A bit boring documentation fix, but gets rid of the warnings:
./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.left' not described in 'drm_tv_connector_state' ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.right' not described in 'drm_tv_connector_state' ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.top' not described in 'drm_tv_connector_state' ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.bottom' not described in 'drm_tv_connector_state'
--- include/drm/drm_connector.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
include/drm/drm_connector.h +5 -1
@@ -342,7 +342,11 @@ int drm_display_info_set_bus_formats(struct drm_display_info *info,/** * struct drm_tv_connector_state - TV connector related states * @subconnector: selected subconnector -* @margins: left/right/top/bottom margins +* @margins: margins +* @margins.left: left margin +* @margins.right: right margin +* @margins.top: top margin +* @margins.bottom: bottom margin * @mode: TV mode * @brightness: brightness in percent * @contrast: contrast in percent
Signature · 6 lines
2.11.0 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Quoted 17 lines · Jani Nikula
A bit boring documentation fix, but gets rid of the warnings:
./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.left' not described in 'drm_tv_connector_state'./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.right' not described in 'drm_tv_connector_state'./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.top' not described in 'drm_tv_connector_state'./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.bottom' not described in 'drm_tv_connector_state'Signed-off-by Jani Nikula <[email protected]>--- include/drm/drm_connector.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)include/drm/drm_connector.h +0
-0
include/drm/drm_connector.h int drm_display_info_set_bus_formats(struct drm_display_info *info, · line 349
Quoted 9 lines
include/drm/drm_connector.h +5
-1@@ -342,7 +342,11 @@ int drm_display_info_set_bus_formats(struct drm_display_info *info,/** * struct drm_tv_connector_state - TV connector related states * @subconnector: selected subconnector -* @margins: left/right/top/bottom margins +* @margins: margins +* @margins.left: left margin +* @margins.right: right margin +* @margins.top: top margin +* @margins.bottom: bottom margin
Well, applying this will now generate a warning on older kerneldocs (due to lack of docs for @margins), but oh well. Can/should we keep both? -Daniel
Quoted 10 lines
include/drm/drm_connector.h +0
-0* @mode: TV mode * @brightness: brightness in percent * @contrast: contrast in percent Signature · 6 lines
2.11.0 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Signature · 7 lines
Daniel Vetter Software Engineer, Intel Corporation http://blog.ffwll.ch _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Quoted 30 lines · Daniel Vetter
Quoted 17 lines · Jani Nikula
A bit boring documentation fix, but gets rid of the warnings:
./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.left' not described in 'drm_tv_connector_state'./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.right' not described in 'drm_tv_connector_state'./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.top' not described in 'drm_tv_connector_state'./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.bottom' not described in 'drm_tv_connector_state'Signed-off-by Jani Nikula <[email protected]>--- include/drm/drm_connector.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)include/drm/drm_connector.h +0
-0include/drm/drm_connector.h int drm_display_info_set_bus_formats(struct drm_display_info *info, · line 349
Quoted 9 lines
include/drm/drm_connector.h +5
-1@@ -342,7 +342,11 @@ int drm_display_info_set_bus_formats(struct drm_display_info *info,/** * struct drm_tv_connector_state - TV connector related states * @subconnector: selected subconnector -* @margins: left/right/top/bottom margins +* @margins: margins +* @margins.left: left margin +* @margins.right: right margin +* @margins.top: top margin +* @margins.bottom: bottom margin Reviewed-by Daniel Vetter <[email protected]>
Quoted 2 lines
Well, applying this will now generate a warning on older kerneldocs (due to lack of docs for @margins), but oh well. Can/should we keep both?
@margins is still there. But old kernel-doc might warn about excess documentation it doesn't know how to parse.
BR,
Jani.
Quoted 12 lines
-Daniel
Quoted 10 lines
include/drm/drm_connector.h +0
-0* @mode: TV mode * @brightness: brightness in percent * @contrast: contrast in percent Signature · 6 lines
2.11.0 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Signature · 5 lines
Jani Nikula, Intel Open Source Technology Center _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Jani Nikula
AppliedQuoted 13 lines · Daniel Vetter
Quoted 12 lines · Jani Nikula
A bit boring documentation fix, but gets rid of the warnings:
./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.left' not described in 'drm_tv_connector_state'./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.right' not described in 'drm_tv_connector_state'./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.top' not described in 'drm_tv_connector_state'./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.bottom' not described in 'drm_tv_connector_state'Signed-off-by Jani Nikula <[email protected]>--- include/drm/drm_connector.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
Quoted 16 lines
Quoted 5 lines
include/drm/drm_connector.h +0
-0include/drm/drm_connector.h int drm_display_info_set_bus_formats(struct drm_display_info *info, · line 349
Quoted 9 lines
include/drm/drm_connector.h +5
-1@@ -342,7 +342,11 @@ int drm_display_info_set_bus_formats(struct drm_display_info *info,/** * struct drm_tv_connector_state - TV connector related states * @subconnector: selected subconnector -* @margins: left/right/top/bottom margins +* @margins: margins +* @margins.left: left margin +* @margins.right: right margin +* @margins.top: top margin +* @margins.bottom: bottom margin Reviewed-by Daniel Vetter <[email protected]>
Pushed to drm-misc-next, thanks for the review.
BR,
Jani.
Quoted 15 lines
Well, applying this will now generate a warning on older kerneldocs (due to lack of docs for @margins), but oh well. Can/should we keep both? -Daniel
Quoted 10 lines
include/drm/drm_connector.h +0
-0* @mode: TV mode * @brightness: brightness in percent * @contrast: contrast in percent Signature · 6 lines
2.11.0 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Signature · 5 lines
Jani Nikula, Intel Open Source Technology Center _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel