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

* at the start of each line not really working #52

Closed
jcredland opened this issue Oct 7, 2017 · 9 comments
Closed

* at the start of each line not really working #52

jcredland opened this issue Oct 7, 2017 · 9 comments

Comments

@jcredland
Copy link

Reformatting comments such as this doesn't work. It needs to identify that every line begins with a start and insert one at the start of the line when wrapping etc.

	/**
	 * Returns the number of samples that can be read, and a pointer where you 
	 * can start reading the samples.  Two calls may be necessary as the samples
	 * to be read might wrap around in memory.
	 * 
	 * This call doesn't copy the samples to a new buffer so is more efficent for
	 * some tasks, e.g. metering, where you just want to calculate a value from 
	 * the available data.  
	*
	* @returns the number of samples, per channel.
	 */
@jcredland
Copy link
Author

jcredland commented Oct 7, 2017

Currently the output when rewrapping this is:

	/**
	 * Returns the number of samples that can be read, and a pointer where you 
	 * can start reading the samples.  Two calls may be necessary as the samples
	 * to be read might wrap around in memory.
	 * 
	 * This call doesn't copy the samples to a new buffer so is more efficent
	   for
	 * some tasks, e.g. metering, where you just want to calculate a value from 
	 * the available 
	 *
	 * @returns the number of samples, per channel.
	 */

The expected output is this:

	/**
	 * Returns the number of samples that can be read, and a pointer where you 
	 * can start reading the samples.  Two calls may be necessary as the samples
	 * to be read might wrap around in memory.
	 * 
	 * This call doesn't copy the samples to a new buffer so is more efficent
	 * for some tasks, e.g. metering, where you just want to calculate a value 
	 * from the available data.   
	 *
	 * @returns the number of samples, per channel.
	 */

@stkb
Copy link
Owner

stkb commented Oct 7, 2017

What language / file extension are you using here? Currently that form only works in Dart, Java, JavaScript, PHP and TypeScript, where it's working fine for me. However since it's also often used in other C languages I was planning to add it to those in the next release.

@stkb
Copy link
Owner

stkb commented Oct 7, 2017

BTW thanks for the review for the Visual Studio version. Could you open another issue for the other problem you mentioned (indents increasing each time)?

@jcredland
Copy link
Author

I'm working in C++ files.

@stkb
Copy link
Owner

stkb commented Oct 9, 2017

Thanks. I've published an update (1.5.2) that supports this in all c-style languages. It should work as expected now.

Just curious, what documentation tool do you use?

@jcredland
Copy link
Author

jcredland commented Oct 9, 2017 via email

@jcredland
Copy link
Author

jcredland commented Oct 9, 2017 via email

@stkb
Copy link
Owner

stkb commented Oct 9, 2017

Doxygen yeah thanks. I wasn't farmiliar with it but from a quick look at the docs it seems I'll need to do a couple of things to better support it. Firstly, it supports /*! or //! comment markers (I'll need to support them too). Also it seems you can use latex-style \tags as an alternative to @tags (currently only the latter is supported).

@stkb
Copy link
Owner

stkb commented Oct 10, 2017

Thanks for the updated review :) Glad it's now working.

@stkb stkb closed this as completed Oct 10, 2017
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

No branches or pull requests

2 participants