camera_metadata: Add 'hal_details' field, rename 'notes' field to 'details'
- Details will contain the full documentation aimed at API users
- HAL details will contain additional notes for HAL implementors
Change-Id: I66452914382b8eca166a032bff4681d7fcef22cf
diff --git a/camera/docs/metadata_model.py b/camera/docs/metadata_model.py
index 7db5ffe..9a920ab 100644
--- a/camera/docs/metadata_model.py
+++ b/camera/docs/metadata_model.py
@@ -1066,7 +1066,8 @@
description: A string with a description of the entry.
range: A string with the range of the values of the entry, e.g. '>= 0'
units: A string with the units of the values, e.g. 'inches'
- notes: A string with the notes for the entry
+ details: A string with the detailed documentation for the entry
+ hal_details: A string with the HAL implementation details for the entry
tag_ids: A list of tag ID strings, e.g. ['BC', 'V1']
type_notes: A string with the notes for the type
visibility: A string describing the visibility, eg 'system', 'hidden',
@@ -1147,8 +1148,12 @@
return self._units
@property
- def notes(self):
- return self._notes
+ def details(self):
+ return self._details
+
+ @property
+ def hal_details(self):
+ return self._hal_details
@property
def tags(self):
@@ -1202,7 +1207,8 @@
self._description = kwargs.get('description')
self._range = kwargs.get('range')
self._units = kwargs.get('units')
- self._notes = kwargs.get('notes')
+ self._details = kwargs.get('details')
+ self._hal_details = kwargs.get('hal_details')
self._tag_ids = kwargs.get('tag_ids', [])
self._tags = None # Filled in by Metadata::_construct_tags
@@ -1344,7 +1350,8 @@
description: A string with a description of the entry.
range: A string with the range of the values of the entry, e.g. '>= 0'
units: A string with the units of the values, e.g. 'inches'
- notes: A string with the notes for the entry
+ details: A string with the detailed documentation for the entry
+ hal_details: A string with the HAL implementation details for the entry
tag_ids: A list of tag ID strings, e.g. ['BC', 'V1']
type_notes: A string with the notes for the type
@@ -1397,7 +1404,8 @@
Args:
entry: An Entry or Clone instance
"""
- props_distinct = ['description', 'units', 'range', 'notes', 'tags', 'kind']
+ props_distinct = ['description', 'units', 'range', 'details',
+ 'hal_details', 'tags', 'kind']
for p in props_distinct:
p = '_' + p