Bug 1015075 - Chapter 6. Internationalization and Localization: Wrong style of some annotations
Summary: Chapter 6. Internationalization and Localization: Wrong style of some annotat...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss Enterprise Application Platform 6
Classification: JBoss
Component: Documentation
Version: 6.2.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: GA
: EAP 6.3.0
Assignee: Misha H. Ali
QA Contact: Russell Dickenson
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-10-03 12:22 UTC by Nikoleta Hlavickova
Modified: 2014-08-14 15:23 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2014-06-28 15:43:04 UTC
Type: Bug


Attachments (Terms of Use)

Description Nikoleta Hlavickova 2013-10-03 12:22:50 UTC
Document URL: 
http://documentation-devel.engineering.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/6.2/html-single/Development_Guide/index.html#chap-Internationalization_and_Localization

Section Number and Name: 
(A) 6.2.4.1. Add Message Ids and Project Codes to Log Messages
(B) 6.2.4.3. Customize Log Messages with Parameters
(C) 6.2.4.4. Specify an Exception as the Cause of a Log Message
(D) 6.2.5.3. Specify One Exception as the Cause of Another Exception

Describe the issue: 
Some annotations in the text are not in bold style: 

(A) Specify a message id for each message using the id attribute of the @Message annotation attached to the method that defines the message. 

(B) A parameter marked with the @Cause annotation is not included in the number of parameters. 

(C) The following procedure shows how to update a logging method using the @Cause parameter to indicate the "causing" exception.

(D) This is done by adding a parameter to the method and annotating the parameter with @Cause.
    The following procedure shows how to update a method from an exception bundle using the @Cause parameter to indicate the causing exception.

Comment 2 Scott Mumford 2014-02-26 05:13:27 UTC
Moving to ON_QA.

The changes should be available for review on the documentation stage within an hour or so from this comment.

http://documentation-devel.engineering.redhat.com/site/documentation/en-US/JBoss_Enterprise_Application_Platform/

Comment 3 Scott Mumford 2014-02-26 05:15:36 UTC
Moving to ON_QA.

The changes should be available for review on the documentation stage within an hour or so from this comment.

http://documentation-devel.engineering.redhat.com/site/documentation/en-US/JBoss_Enterprise_Application_Platform/

Comment 4 Nikoleta Hlavickova 2014-02-26 14:20:27 UTC
Verified with EAP 6.3.0 DR1


Note You need to log in before you can comment on or make changes to this bug.