several problems and suggestions for Axis introductory documentation
--------------------------------------------------------------------
Key: AXIS-2797
URL: https://issues.apache.org/jira/browse/AXIS-2797
Project: Axis
Issue Type: Bug
Components: Documentation
Affects Versions: 1.2
Environment:
http://ws.apache.org/axis/java/user-guide.html#Introduction
Reporter: Todd Bradley
Priority: Minor
Hi, I'm new to Axis and naturally was compelled to read the introduction
section of the user guide, located here:
http://ws.apache.org/axis/java/user-guide.html#Introduction
There are some minor errors in the intro section of the document that I noticed:
1) Line 15 of the echoString example under "Basics - Getting Started" would
give any Java compiler fits. There's a " missing.
2) A little later on, there's a sentence that says "look at the colored
sections" but there are no colored sections in the example.
3. Later, there's text that says "Take a look at the section which we've
highlighted in red" but there is no section highlighted in red, either.
4. The docs are awesome and easy to read, especially compared to documentation
for some other open source software I use. But it might slightly help
readability to choose a code formatting style and stick with it. It looks like
one author puts spaces after his open parens, and another one doesn't.
call.setReturnType( org.apache.axis.Constants.XSD_STRING );
compared to
call.setReturnClass(String.class);
5. Finally, as I learned the first time I tried to send this message, there's a
mismatch of feedback mechanisms. The document says to send feedback to
"axis-dev@ws.apache.org". However, when I tried that, my email bounced back
saying only subscribers can send to that list. As a brand new user, I'm the
farthest thing from an Axis developer possible, so subscribing to the email
list seems inappropriate. You should either update the doc to suggest another
address for feedback, or make it so average users can send feedback to you.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
