Uploaded image for project: 'Camel'
  1. Camel
  2. CAMEL-12422

Wrong language syntax declarations for code samples in documentation

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • 2.21.0
    • 2.21.1, 2.22.0
    • documentation
    • None
    • Unknown

    Description

      AsciiDoc has the ability to support syntax highlighting, which can be enabled by putting the following line before a code sample (e.g. for Java code):

      [source,java]

      However, there are some places in the documentation where this declaration is used, but the code sample that follows is not Java. This can cause incorrect syntax highlighting or (more seriously) can sometimes cause a documentation build to crash. The following doc files are affected:

      • csv-dataformat.adoc
      • mime-multipart-dataformat.adoc
      • mongodb-gridfs-component.adoc
      • snmp-component.adoc

      I plan to submit a PR to fix these files.

      Attachments

        Activity

          People

            acosentino Andrea Cosentino
            fbolton Fintan Bolton
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: