1 /* |
1 /* |
2 * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved. |
2 * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. |
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 * |
4 * |
5 * This code is free software; you can redistribute it and/or modify it |
5 * This code is free software; you can redistribute it and/or modify it |
6 * under the terms of the GNU General Public License version 2 only, as |
6 * under the terms of the GNU General Public License version 2 only, as |
7 * published by the Free Software Foundation. Oracle designates this |
7 * published by the Free Software Foundation. Oracle designates this |
77 * Returns the text of the documentation ("Javadoc") |
77 * Returns the text of the documentation ("Javadoc") |
78 * comment of an element. |
78 * comment of an element. |
79 * |
79 * |
80 * <p> A documentation comment of an element is a comment that |
80 * <p> A documentation comment of an element is a comment that |
81 * begins with "{@code /**}" , ends with a separate |
81 * begins with "{@code /**}" , ends with a separate |
82 * "<code>*/</code>", and immediately precedes the element, |
82 * "<code>*/</code>", and immediately precedes the element, |
83 * ignoring white space. Therefore, a documentation comment |
83 * ignoring white space. Therefore, a documentation comment |
84 * contains at least three"{@code *}" characters. The text |
84 * contains at least three"{@code *}" characters. The text |
85 * returned for the documentation comment is a processed form of |
85 * returned for the documentation comment is a processed form of |
86 * the comment as it appears in source code. The leading "{@code |
86 * the comment as it appears in source code. The leading "{@code |
87 * /**}" and trailing "<code>*/</code>" are removed. For lines |
87 * /**}" and trailing "<code>*/</code>" are removed. For lines |
88 * of the comment starting after the initial "{@code /**}", |
88 * of the comment starting after the initial "{@code /**}", |
89 * leading white space characters are discarded as are any |
89 * leading white space characters are discarded as are any |
90 * consecutive "{@code *}" characters appearing after the white |
90 * consecutive "{@code *}" characters appearing after the white |
91 * space or starting the line. The processed lines are then |
91 * space or starting the line. The processed lines are then |
92 * concatenated together (including line terminators) and |
92 * concatenated together (including line terminators) and |