Keywords and links should be translated to REST type language so it makes sense in the produced swagger file, perhaps a keyword dictionary would be nice so this can be amended by others?
Example bold areas should be translated:
Adds the {@param.name usedByEntity} to the {@link CategoryModel#usedBy} subscribers {@term set} for the specified category. If the {@param.name usedByEntity} is already in the {@term set}, then this becomes an idempotent no-op. To invoke this {@term operation}, you need the modify {@link CategoryModel#usedBy} privilege on the category.
Keywords and links should be translated to REST type language so it makes sense in the produced swagger file, perhaps a keyword dictionary would be nice so this can be amended by others?
Example bold areas should be translated:
Adds the {@param.name usedByEntity} to the {@link CategoryModel#usedBy} subscribers {@term set} for the specified category. If the {@param.name usedByEntity} is already in the {@term set}, then this becomes an idempotent no-op. To invoke this {@term operation}, you need the modify {@link CategoryModel#usedBy} privilege on the category.