Mirrors_Framework/PX4-Autopilot
1
0
Fork 0
mirror of https://github.com/PX4/PX4-Autopilot.git synced 2026-05-28 10:46:33 +08:00
Code Issues Actions 28 Packages Projects Releases Wiki Activity

generate uorb - support multiline descriptions

Browse Source
This commit is contained in:
Hamish Willee
2021-08-16 09:41:51 +10:00
committed by Beat Küng
parent 9c081ed24b
commit 8aecc64a73
1 changed files with 19 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
msg/tools/generate_msg_docs.py
+19 -12
View File
@@ -41,18 +41,26 @@ if __name__ == "__main__":
msg_url="[source file](https://github.com/PX4/PX4-Autopilot/blob/master/msg/%s)" % msg_file msg_url="[source file](https://github.com/PX4/PX4-Autopilot/blob/master/msg/%s)" % msg_file
msg_description = "" msg_description = ""
summary_description = ""
#Get msg description (first non-empty comment line from top of msg) #Get msg description (first non-empty comment line from top of msg)
with open(msg_filename, 'r') as lineparser: with open(msg_filename, 'r') as lineparser:
line = lineparser.readline().strip() line = lineparser.readline()
while line.startswith('#'): while line.startswith('#') or (line.strip() == ''):
#print('DEBUG: line: %s' % line) print('DEBUG: line: %s' % line)
line=line[1:].strip() line=line[1:].strip()+'\n'
if line: stripped_line=line.strip()
msg_description=line if msg_description and not summary_description and stripped_line=='':
print('msg_description: Z%sZ' % msg_description) summary_description = msg_description.strip()
break
line = lineparser.readline()
msg_description+=line
line = lineparser.readline()
msg_description=msg_description.strip()
if not summary_description and msg_description:
summary_description = msg_description
print('msg_description: Z%sZ' % msg_description)
print('summary_description: Z%sZ' % summary_description)
summary_description
msg_contents = "" msg_contents = ""
#Get msg contents (read the file) #Get msg contents (read the file)
with open(msg_filename, 'r') as source_file: with open(msg_filename, 'r') as source_file:
@@ -75,8 +83,8 @@ if __name__ == "__main__":
content_file.write(markdown_output) content_file.write(markdown_output)
readme_markdown_file_link='- [%s](%s.md)' % (msg_name,msg_name) readme_markdown_file_link='- [%s](%s.md)' % (msg_name,msg_name)
if msg_description: if summary_description:
readme_markdown_file_link+=" — %s" % msg_description readme_markdown_file_link+=" — %s" % summary_description
filelist_in_markdown+=readme_markdown_file_link+"\n" filelist_in_markdown+=readme_markdown_file_link+"\n"
# Write out the README.md file # Write out the README.md file
@@ -94,4 +102,3 @@ Graphs showing how these are used [can be found here](../middleware/uorb_graph.m
readme_file = os.path.join(output_dir, 'README.md') readme_file = os.path.join(output_dir, 'README.md')
with open(readme_file, 'w') as content_file: with open(readme_file, 'w') as content_file:
content_file.write(readme_text) content_file.write(readme_text)