Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better layout of lists in output formats #10132

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

albert-github
Copy link
Collaborator

In different output format the layout of some listing was not correct (especially in the RTF output):

  • missing space after the word "directory" (whilst present after the word "file")
  • missing separators in lists (the big dots), due to missing initial initial parts, i.e. strange concatenation of items (when brief was missing).

Example: example.tar.gz

In different output format the layout of some listing was not correct (especially in the RTF output):
- missing space after the word "directory" (whilst present after the word "file")
- missing separators in lists (the big dots), due to missing initial initial parts, i.e. strange concatenation of items (when brief was missing).
@@ -946,7 +946,7 @@ void GroupDefImpl::writeDirs(OutputList &ol,const QCString &title)
if (!dd->hasDocumentation()) continue;
ol.startMemberDeclaration();
ol.startMemberItem(dd->getOutputFileBase(),OutputGenerator::MemberItemType::Normal);
ol.parseText(theTranslator->trDir(FALSE,TRUE));
ol.docify(theTranslator->trDir(FALSE,TRUE)+" ");
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wouldn't it be better to move adding the space inside insertMemberAlign() for those formats that require it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made it so that it is analogous to the code in void GroupDefImpl::writeFiles(OutputList &ol,const QCString &title) where we already have: ol.docify(theTranslator->trFile(FALSE,TRUE)+" ");
The change is required for LaTeX, RTF, Docbook (I didn't test it for man). For the HTML output it doesn't really hurt.
When looking where insertMemberAlign() is used we see that this is in:

  • classdef.cpp
  • conceptdef.cpp
  • dirdef.cpp
  • groupdef.cpp
  • namespacedef.cpp
  • vhdldocgen.cpp

With dirdef.cpp there is currently no space either and I don't know what the effect would be , though the fact that there is a <span... line a little above it I think it is here only used in HTML or tag file.
The situation in vhdldocgen.cpp is a bit more complicated as here we see that there is here sometimes a space before or (often) after the call to insertMemberAlign.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants