dox icon indicating copy to clipboard operation
dox copied to clipboard

Incorrect code block for doc comment

Open Gama11 opened this issue 7 years ago • 3 comments

http://haxefoundation.github.io/hxnodejs/js/node/child_process/ChildProcessEvent.html

The source doesn't look too crazy, no mixed indentation or anything like that, so this should probably work ok?

	/**
		Emitted when:
			1. The process could not be spawned, or
			2. The process could not be killed, or
			3. Sending a message to the child process failed for whatever reason.

		Note that the exit-event may or may not fire after an error has occured.
		If you are listening on both events to fire a function, remember to guard against calling your function twice.

		See also `ChildProcess.kill` and `ChildProcess.send`.
	**/
	var Error : ChildProcessEvent<js.Error->Void> = "error";

Gama11 avatar Apr 16 '18 09:04 Gama11

I think this is mostlikely a haxe-markdown bug (?)

markknol avatar Apr 16 '18 09:04 markknol

I doubt it, vshaxe has the same issue and doesn't use haxe-markdown (I copied some code from JavadocHandler / MarkdownHandler for it). So I think indentation is handled incorrectly somewhere.

Gama11 avatar Apr 16 '18 09:04 Gama11

MarkdownHandler

Actually, that's not true, the code I meant is in Processor: https://github.com/HaxeFoundation/dox/blob/046aa4cdee0f013c27b54778c778492e6faf2a40/src/dox/Processor.hx#L279

Gama11 avatar Apr 16 '18 09:04 Gama11