Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 361522 - Bug collection of Xtext-Documentation.pdf for Xtext 2.x
Summary: Bug collection of Xtext-Documentation.pdf for Xtext 2.x
Status: CLOSED FIXED
Alias: None
Product: TMF
Classification: Modeling
Component: Xtext (show other bugs)
Version: 2.0.1   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: RC2   Edit
Assignee: Project Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-10-20 07:27 EDT by Bernhard Merkle CLA
Modified: 2017-10-31 10:58 EDT (History)
1 user (show)

See Also:
jan: juno+

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Bernhard Merkle CLA 2011-10-20 07:27:19 EDT 
Collection of bugs in the Xtext Documentation
Comment 1 Bernhard Merkle CLA 2011-10-20 07:28:48 EDT 
page 17: screenshot of eclipse IDE is not usefull here.
I think this is superflous. The separation of .dmodel files should not be interrupted here
Comment 2 Bernhard Merkle CLA 2011-10-20 07:29:51 EDT 
page21: The same as in #comment2 is in chapter 3.5
Comment 3 Bernhard Merkle CLA 2011-10-20 07:36:34 EDT 
page 33: for a novice user, chapter 4.2 is too short an incomlete (codewise).
The user has to look up on of the existing example code (e.g. for imports etc) to fully understand how to write tests. With the current doc for 4.2 it is not possible to get to a valid test case.
Comment 4 Bernhard Merkle CLA 2011-10-20 10:09:07 EDT 
page 71, 72 etc
these pages contain only two bullets with "Resource" but I think there should be a reference/hyperlink to an API
Comment 5 Jan Koehnlein CLA 2012-05-25 04:50:11 EDT 
Thanks for the feedback.

The PDF is not our main artifact, and the strange placement of pictures is a tribute to automatically generating LaTeX. I am afraid, we cannot do too much about comment #1 and comment #2.

(In reply to comment #3)
> page 33: for a novice user, chapter 4.2 is too short an incomlete (codewise).
> The user has to look up on of the existing example code (e.g. for imports etc)
> to fully understand how to write tests. With the current doc for 4.2 it is not
> possible to get to a valid test case.

I improved that section a bit.

(In reply to comment #4)
> page 71, 72 etc
> these pages contain only two bullets with "Resource" but I think there should
> be a reference/hyperlink to an API

Fixed a bug in the Xdoc generator to fix this.
Comment 6 Eclipse Webmaster CLA 2017-10-31 10:47:46 EDT 
Requested via bug 522520.

-M.
Comment 7 Eclipse Webmaster CLA 2017-10-31 10:58:50 EDT 
Requested via bug 522520.

-M.