PR# 19332 [er] Missing characters in documentation generated file class_list.html
Problem Report Summary
Submitter: axarosenberg
Category: Documentation
Priority: Low
Date: 2017/02/21
Class: Bug
Severity: Non-critical
Number: 19332
Release: 17.01
Confidential: No
Status: Closed
Responsible:
Environment: win
Synopsis: [er] Missing characters in documentation generated file class_list.html
Description
We use the following command: ec -filter html-stylesheet -all ... as shown here: https://www.eiffel.org/doc/eiffelstudio/EiffelStudio%3A%20Using%20command%20line%20options#Commands_for_generating_documentation to generate documentation. In the generated file class_list.html, for class ACTIVE, the comment should start with: -- ``Active'' data structure but the documentation generator produces: -- Active'' data structure More generally, I don't think that it is a good thing to remove the quotes when we have `foo', or to remove the braces when we have {FOO}. The text could be made clickable without removing these extra characters. After all, this is what is done when we have {FOO}.bar. Keeping these extra characters would make it easier to copy the pretty-printed text generated by the documentation generator and paste it in a class text file. -- Eric Bezault
To Reproduce
Problem Report Interactions
Replacing ``foo'' by `foo' does not seem judicious to me. The characters ` and ' have a special meaning in Eiffel comments. But in the cases involved, foo is not an Eiffel entity, just emphasized text. So, I would have rather replaced ``foo'' by "foo". -- Eric Bezault
The ``active'' instead of ``Active'' is now fixed in trunk source code. However the current documentation generation system does not allow to keep the quoted or curly braces easily. We will try to see if this is possible to improve the system to address those annoyance, but this is not high priority or importance for now. Thanks for the reports.