110915Sandreas.sandberg@arm.com#!/bin/sed -f 210915Sandreas.sandberg@arm.com# 310915Sandreas.sandberg@arm.com# Copyright (c) 2014-2015 ARM Limited 410915Sandreas.sandberg@arm.com# All rights reserved 510915Sandreas.sandberg@arm.com# 610915Sandreas.sandberg@arm.com# Licensed under the Apache License, Version 2.0 (the "License"); 710915Sandreas.sandberg@arm.com# you may not use this file except in compliance with the License. 810915Sandreas.sandberg@arm.com# You may obtain a copy of the License at 910915Sandreas.sandberg@arm.com# 1010915Sandreas.sandberg@arm.com# http://www.apache.org/licenses/LICENSE-2.0 1110915Sandreas.sandberg@arm.com# 1210915Sandreas.sandberg@arm.com# Unless required by applicable law or agreed to in writing, software 1310915Sandreas.sandberg@arm.com# distributed under the License is distributed on an "AS IS" BASIS, 1410915Sandreas.sandberg@arm.com# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1510915Sandreas.sandberg@arm.com# See the License for the specific language governing permissions and 1610915Sandreas.sandberg@arm.com# limitations under the License. 1710915Sandreas.sandberg@arm.com# 1810915Sandreas.sandberg@arm.com# Authors: Andreas Sandberg 1910915Sandreas.sandberg@arm.com 2010915Sandreas.sandberg@arm.com# READ BEFORE EDITING: 2110915Sandreas.sandberg@arm.com# 2210915Sandreas.sandberg@arm.com# * Avoid adding or removing newlines (e.g., deleting matched lines). It's 2310915Sandreas.sandberg@arm.com# much easier to understand the Doxygen logs if they point to the right 2410915Sandreas.sandberg@arm.com# line in the source files. 2510915Sandreas.sandberg@arm.com# 2610915Sandreas.sandberg@arm.com# * SED can be hard to read, so please document what your replacement rules 2710915Sandreas.sandberg@arm.com# are supposed to do and why. 2810915Sandreas.sandberg@arm.com# 2910915Sandreas.sandberg@arm.com 3010915Sandreas.sandberg@arm.com# Handle TODO/FIXME/BUG comments 3110915Sandreas.sandberg@arm.com/\/\/ \(TODO\|FIXME\|BUG\):/ { 3210915Sandreas.sandberg@arm.com # Transform the first line of the comment block into a Doxygen C++ comment. 3310915Sandreas.sandberg@arm.com s/\([^\]\)\/\/ /\1\/\/\/ /; 3410915Sandreas.sandberg@arm.com 3510915Sandreas.sandberg@arm.com : todo_comment_cont 3610915Sandreas.sandberg@arm.com # Replace any TODO/FIXME/BUG commands with Doxygen equivalents 3710915Sandreas.sandberg@arm.com s/\(TODO\|FIXME\):/@todo /; 3810915Sandreas.sandberg@arm.com s/\(BUG\):/@bug /; 3910915Sandreas.sandberg@arm.com # Get the next line 4010915Sandreas.sandberg@arm.com n; 4110915Sandreas.sandberg@arm.com # If this line is only contains whitespace and a comment, it is a 4210915Sandreas.sandberg@arm.com # conntinuation of the previous line. If so, make it a Doxygen comment. 4310915Sandreas.sandberg@arm.com s/\([:space:]*\)\/\/\([^\/]\)/\1\/\/\/\2/ ; 4410915Sandreas.sandberg@arm.com # Try to match another line if the previous s command matched a line. 4510915Sandreas.sandberg@arm.com t todo_comment_cont; 4610915Sandreas.sandberg@arm.com} 47