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.

Sign up for GitHub

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

Jump to bottom

Consulo not rendering documentation comments correctly #566

Open
TCROC opened this issue Dec 4, 2020 · 2 comments
Open

Consulo not rendering documentation comments correctly #566

TCROC opened this issue Dec 4, 2020 · 2 comments
Assignees
@VISTALL
Labels
prio: normal subsystem: documentation type: bug

Comments

@TCROC
Copy link

TCROC commented Dec 4, 2020 •
edited
Loading

OS: Ubuntu 18.04
consulo.log

About Info 

 Consulo:
  version = 2020.12
  build number = 2748
  build date = December 3, 2020
 Plugins:
  com.intellij = 2748
  com.intellij.git = 1230
  com.intellij.regexp = 1180
  com.intellij.spellchecker = 1187
  com.intellij.xml = 2653
  com.intellij.properties = 2757
  consulo.dotnet = 3275
  consulo.dotnet.microsoft = 3805
  consulo.dotnet.mono = 3818
  consulo.csharp = 4815
  consulo.javascript = 3062
  consulo.library.batik = 484
  com.intellij.images = 1875
  consulo.library.flexmark = 484
  com.intellij.tasks = 4550
  consulo.msbuild = 4099
  consulo.nuget = 4330
  consulo.nunit = 4347
  consulo.opencover = 3244
  consulo.platform.desktop = 2748
  org.jetbrains.plugins.github = 4224
  org.jetbrains.plugins.terminal = 1091
  org.jetbrains.plugins.yaml = 2123
  consulo.unity3d = 7490
 JVM:
  vendor = JetBrains s.r.o
  version = 11.0.4
  runtimeVersion = 11.0.4+10-b304.77
  locale = en_US
 JVM Env:
  __idea.mac.env.lock = unlocked
  awt.toolkit = sun.awt.X11.XToolkit
  java.specification.version = 11
  sun.cpu.isalist = 
  sun.jnu.encoding = UTF-8
  log4j.shutdownHookEnabled = false
  sun.arch.data.model = 64
  consulo.properties.file = /home/t-croc/Applications/Consulo/consulo.properties
  sun.font.fontmanager = sun.awt.X11FontManager
  idea.properties.file = /home/t-croc/Applications/Consulo/consulo.properties
  java.vendor.url = https://www.jetbrains.com/
  consulo.home.path = /home/t-croc/Applications/Consulo/platform/build2748
  sun.java2d.uiScale.enabled = true
  log4j2.messageFactory = org.apache.logging.log4j.message.SimpleMessageFactory
  sun.io.useCanonCaches = false
  sun.boot.library.path = /home/t-croc/Applications/Consulo/platform/build2748/jre/lib
  jna.tmpdir = /home/t-croc/.consulo_settings/system/tmp
  sun.java.command = consulo.desktop.bootstrap/consulo.desktop.boot.main.Main
  jdk.debug = release
  sun.awt.exception.handler = com.intellij.openapi.application.impl.AWTExceptionHandler
  java.specification.vendor = Oracle Corporation
  jdk.module.path = /home/t-croc/Applications/Consulo/platform/build2748/boot
  java.version.date = 2019-07-16
  java.home = /home/t-croc/Applications/Consulo/platform/build2748/jre
  file.separator = /
  java.vm.compressedOopsMode = 32-bit
  line.separator = \n
  java.specification.name = Java Platform API Specification
  java.vm.specification.vendor = Oracle Corporation
  idea.home.path = /home/t-croc/Applications/Consulo/platform/build2748
  jdk.module.main.class = consulo.desktop.boot.main.Main
  awt.useSystemAAFontSettings = lcd
  sun.management.compiler = HotSpot 64-Bit Tiered Compilers
  jb.restart.code = 88
  java.runtime.version = 11.0.4+10-b304.77
  user.name = t-croc
  javax.swing.rebaseCssSizeMap = true
  sun.java2d.pmoffscreen = false
  sun.awt.noerasebackground = true
  file.encoding = UTF-8
  sun.java2d.noddraw = true
  jnidispatch.path = /home/t-croc/.consulo_settings/system/tmp/jna15762982827396263579.tmp
  idea.popup.weight = heavy
  jna.loaded = true
  java.io.tmpdir = /tmp
  java.version = 11.0.4
  java.vm.specification.name = Java Virtual Machine Specification
  java.awt.printerjob = sun.print.PSPrinterJob
  sun.os.patch.level = unknown
  consulo.vm.options.file = /home/t-croc/Applications/Consulo/consulo64.vmoptions
  java.library.path = /home/t-croc/Applications/Consulo/platform/build2748/bin:/home/t-croc/Applications/Consulo/platform/build2748/bin::/usr/java/packages/lib:/usr/lib64:/lib64:/lib:/usr/lib
  java.vendor = JetBrains s.r.o
  io.netty.processId = 28738
  sun.io.unicode.encoding = UnicodeLittle
  java.rmi.server.disableHttp = true
  io.netty.machineId = 28:f0:76:ff:fe:16:65:0e
  java.util.concurrent.ForkJoinPool.common.parallelism = 8
  sun.desktop = gnome
  java.class.path = 
  sun.awt.enableExtraMouseButtons = true
  java.vm.vendor = JetBrains s.r.o
  consulo.module.path.boot = true
  java.util.Arrays.useLegacyMergeSort = true
  user.timezone = America/New_York
  jb.vmOptionsFile = /home/t-croc/Applications/Consulo/consulo64.vmoptions
  idea.no.launcher = false
  swing.bufferPerWindow = false
  os.name = Linux
  java.vm.specification.version = 11
  sun.java.launcher = SUN_STANDARD
  user.country = US
  sun.cpu.endian = little
  user.home = /home/t-croc
  user.language = en
  idea.cycle.buffer.size = 1024
  java.awt.graphicsenv = sun.awt.X11GraphicsEnvironment
  jdk.module.main = consulo.desktop.bootstrap
  idea.max.intellisense.filesize = 2500
  sun.java2d.d3d = false
  java.net.preferIPv4Stack = true
  path.separator = :
  idea.use.default.antialiasing.in.editor = false
  os.version = 5.4.0-56-generic
  jna.nosys = true
  java.runtime.name = OpenJDK Runtime Environment
  sun.nio.ch.bugLevel = 
  java.vm.name = OpenJDK 64-Bit Server VM
  jna.platform.library.path = /usr/lib/x86_64-linux-gnu:/lib/x86_64-linux-gnu:/lib64:/usr/lib:/lib:/usr/lib/i386-linux-gnu:/lib/i386-linux-gnu:/lib32:/usr/lib32
  java.vendor.url.bug = https://youtrack.jetbrains.com
  java.util.concurrent.ForkJoinPool.common.threadFactory = consulo.bootstrap.concurrent.IdeaForkJoinWorkerThreadFactory
  user.dir = /home/t-croc
  os.arch = amd64
  io.netty.serviceThreadPrefix = Netty 
  idea.dynamic.classpath = false
  java.vm.info = mixed mode
  java.vm.version = 11.0.4+10-b304.77
  java.rmi.server.hostname = localhost
  sun.awt.datatransfer.timeout = 2000
  java.class.version = 55.0
 OS:
  name = Linux
  version = 5.4.0-56-generic
  arch = amd64
 Env:
  PATH = /usr/sbin:/usr/bin:/sbin:/bin:/snap/bin:/home/t-croc/.dotnet/tools
  XAUTHORITY = /run/user/1000/gdm/Xauthority
  XMODIFIERS = @im=ibus
  XDG_DATA_DIRS = /usr/share/ubuntu:/usr/local/share/:/usr/share/:/var/lib/snapd/desktop
  GDMSESSION = ubuntu
  MANDATORY_PATH = /usr/share/gconf/ubuntu.mandatory.path
  TEXTDOMAINDIR = /usr/share/locale/
  GTK_IM_MODULE = ibus
  DBUS_SESSION_BUS_ADDRESS = unix:path=/run/user/1000/bus
  DEFAULTS_PATH = /usr/share/gconf/ubuntu.default.path
  XDG_CURRENT_DESKTOP = ubuntu:GNOME
  SSH_AGENT_PID = 1572
  LD_LIBRARY_PATH = /home/t-croc/Applications/Consulo/platform/build2748/bin:/home/t-croc/Applications/Consulo/platform/build2748/bin:
  QT4_IM_MODULE = xim
  SESSION_MANAGER = local/tcroc-Z390-UD:@/tmp/.ICE-unix/1476,unix/tcroc-Z390-UD:/tmp/.ICE-unix/1476
  USERNAME = t-croc
  LOGNAME = t-croc
  PWD = /home/t-croc
  IM_CONFIG_PHASE = 2
  GJS_DEBUG_TOPICS = JS ERROR;JS LOG
  SHELL = /bin/bash
  GIO_LAUNCHED_DESKTOP_FILE = /home/t-croc/.local/share/applications/alacarte-made-3.desktop
  GNOME_DESKTOP_SESSION_ID = this-is-deprecated
  GTK_MODULES = gail:atk-bridge
  CLUTTER_IM_MODULE = xim
  TEXTDOMAIN = im-config
  ALL_JVM_ARGS = --add-opens=java.desktop/sun.awt=consulo.container.impl --add-opens=java.desktop/sun.awt.image=consulo.container.impl --add-opens=java.desktop/sun.java2d=consulo.container.impl --add-opens=java.desktop/sun.font=consulo.container.impl --add-opens=java.desktop/java.awt=consulo.container.impl --add-opens=java.desktop/javax.swing=consulo.container.impl --add-opens=java.desktop/javax.swing.plaf.basic=consulo.container.impl --add-opens=java.base/java.lang=consulo.container.impl --add-opens=java.desktop/javax.swing.text.html=consulo.container.impl --add-opens=java.desktop/java.awt.peer=consulo.container.impl  -Xms512m -Xmx1500m -XX:ReservedCodeCacheSize=240m -ea -Dsun.io.useCanonCaches=false -Djava.net.preferIPv4Stack=true -XX:+UseCodeCacheFlushing -XX:+UseConcMarkSweepGC -XX:SoftRefLRUPolicyMSPerMB=50 -XX:+HeapDumpOnOutOfMemoryError -Dawt.useSystemAAFontSettings=lcd  -Djb.vmOptionsFile="/home/t-croc/Applications/Consulo/consulo64.vmoptions" -Dconsulo.vm.options.file="/home/t-croc/Applications/Consulo/consulo64.vmoptions" -p "/home/t-croc/Applications/Consulo/platform/build2748/boot" -Dconsulo.module.path.boot=true -Dconsulo.home.path="/home/t-croc/Applications/Consulo/platform/build2748" -Didea.home.path="/home/t-croc/Applications/Consulo/platform/build2748" -Didea.properties.file="/home/t-croc/Applications/Consulo/consulo.properties" -Dconsulo.properties.file="/home/t-croc/Applications/Consulo/consulo.properties"   
  XDG_SESSION_DESKTOP = ubuntu
  CONSULO_HOME = /home/t-croc/Applications/Consulo/platform/build2748
  SHLVL = 0
  QT_IM_MODULE = xim
  XDG_CONFIG_DIRS = /etc/xdg/xdg-ubuntu:/etc/xdg
  LANG = en_US.UTF-8
  XDG_SESSION_ID = 3
  XDG_SESSION_TYPE = x11
  JDK = /home/t-croc/Applications/Consulo/platform/build2748/jre
  DISPLAY = :1
  ROOT_DIR = /home/t-croc/Applications/Consulo
  MAIN_CLASS_NAME = -m consulo.desktop.bootstrap/consulo.desktop.boot.main.Main
  GPG_AGENT_INFO = /run/user/1000/gnupg/S.gpg-agent:0:1
  DESKTOP_SESSION = ubuntu
  USER = t-croc
  XDG_MENU_PREFIX = gnome-
  GIO_LAUNCHED_DESKTOP_FILE_PID = 4767
  QT_ACCESSIBILITY = 1
  WINDOWPATH = 2
  GJS_DEBUG_OUTPUT = stderr
  SSH_AUTH_SOCK = /run/user/1000/keyring/ssh
  XDG_SEAT = seat0
  GNOME_SHELL_SESSION_MODE = ubuntu
  XDG_VTNR = 2
  XDG_RUNTIME_DIR = /run/user/1000
  HOME = /home/t-croc

Any comments starting with and following the <cref> tag are not rendering. Any <param> tags are not rendering. If there is a <typeparam> tag, no comments are rendered.

<cref> and <param> tags:
image

<typeparam> tag:
image

These are the documentation comments that I uses most often, so that is how I noticed them not rendering correctly. More of C#'s documentation comments can be found here: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments.

Does Consulo support all of C#'s documentation comments? If not, I'll open up another issue as a feature request to support the tags.

Here is the example script I used for testing:

using System;

public class Program
{
        public static void Main(String[] args)
        {
            Console.WriteLine("Hello World!!!");

	    SomeMethod("test", 1, 3.5);

	    SomeGenericMethod<string>("test", "test2", 3);
        }

	/// <summary>
	/// This is a description for the method. It exists in the <see cref="Program"/> class.
	/// </summary>
	/// <param name="param1">This is a description for the parameter. It is a string.</param>
	/// <param name="param2">This is a description for the second parameter. It is an integer.</param>
	/// <param name="param3">This is a description for the third parameter. It is a double.</param>
        public static void SomeMethod(string param1, int param2, double param3)
        { 
		    Console.WriteLine("Just a method here");
        }

	/// <summary>
	/// This is a description for the method. It exists in the <see cref="Program"/> class.
	/// </summary>
	/// <typeparam name="T">Supply any type here</typeparam>
	/// <param name="param1">This is a string parameter</param>
	/// <param name="param2">this is a generic parameter</param>
	/// <param name="param3">This is a double parameter</param>
	public static void SomeGenericMethod<T>(string param1, T param2, double param3)
	{
		Console.WriteLine($"The type is {typeof(T)}");
	}
}
@VISTALL VISTALL self-assigned this Dec 4, 2020
@VISTALL
Copy link
Member

VISTALL commented Dec 4, 2020

Good day. Console have draft support for docs. For now we will fix this problem, and later will found new bugs.

Thanks.

@TCROC
Copy link
Author

TCROC commented Dec 4, 2020

Good day to you as well and thanks as well! :)

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

@VISTALL VISTALL

Labels
prio: normal subsystem: documentation type: bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@VISTALL @TCROC