Skip to content

#467: generate summary XML in docs command#951

Open
nacNAC333 wants to merge 1 commit into
objectionary:masterfrom
nacNAC333:467
Open

#467: generate summary XML in docs command#951
nacNAC333 wants to merge 1 commit into
objectionary:masterfrom
nacNAC333:467

Conversation

@nacNAC333
Copy link
Copy Markdown

Fixes #467

Adds summary XML file generation to the docs command. After generating HTML documentation, the command now also produces a summary.xml file in <eodoc> format listing all packages and objects.

Changes:

  • Add xmlEscape() helper for safe XML entity escaping
  • Generate summary.xml with <eodoc> root, <package> and <object> children
  • Include packages and objects count attributes on root element

@yegor256
Copy link
Copy Markdown
Member

@nacNAC333 Thanks for your contribution! Unfortunately, we can't merge it without tests. Every feature we add and every bug we fix must be accompanied by at least one new test that confirms that the code was not working before. Without such a test, how can we know that what you commit actually works?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs.js doesn't generate a summary XML file

2 participants