[MDSAL-46] Generated javadoc contains symbols of javadoc comment tags Created: 03/Sep/14  Updated: 09/Mar/18  Due: 21/Jan/16  Resolved: 22/Feb/16

Status: Resolved
Project: mdsal
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Bug
Reporter: Martin Sunal Assignee: Igor Foltin
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: Windows
Platform: PC

Issue Links:
Duplicate
is duplicated by MDSAL-72 Javadoc contains unwanted html entity... Resolved
External issue ID: 1672

 Description   

Symbols of javadoc comment tags are not encoded during generation from yang description.

this description in yang:
description "e.g. 1//";

is represented in javadoc like:
/**

  • e.g. 1//
    */

so you get compilation error

encoding for javadoc comment tags:
use / instead of /
use * instead of *

 Comments   
Comment by Ladislav Borak [ 04/Sep/14 ]

proposed patch: https://git.opendaylight.org/gerrit/#/c/10753/

Comment by Colin Dixon [ 15/Jun/15 ]

This is still true, but for the HTML formatting elements in comments.

/**

  • <p>This class represents the following YANG schema fragment defined in module <b>multilevelmodeling</b>
  • <br>(Source path: <i>META-INF/yang/multilevelmodeling.yang</i>):
  • <pre>

It should look like:

/**

  • <p>This class represents the following YANG schema fragment defined in module <b>multilevelmodeling</b>
  • <br>(Source path: <i>META-INF/yang/multilevelmodeling.yang</i>):
  • <pre>
Comment by Martin Ciglan [ 28/Aug/15 ]

Based on latest MD-SAL split off and moving binding modules from Yangtools to MD-SAL, moving this bug to MD-SAL.

Comment by Igor Foltin [ 31/Aug/15 ]

fix pushed:
https://git.opendaylight.org/gerrit/#/c/26235/

Comment by Robert Varga [ 10/Nov/15 ]

Reopening, as the patch was reverted in: https://git.opendaylight.org/gerrit/29512. Make sure the follow-up patch is tested at least against controller, openflowjava, openflowplugin and bgpcep projects.

Comment by Igor Foltin [ 21/Jan/16 ]

New fix pushed:

https://git.opendaylight.org/gerrit/#/c/33207/

Comment by Robert Varga [ 04/Feb/16 ]

stable/be: https://git.opendaylight.org/gerrit/34060

Generated at Wed Feb 07 20:08:30 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.