This forum has been archived. All content is frozen. Please use KDE Discuss instead.

[Kdevelop] Support one of language to text formating

2

Votes
2
0
Tags: None
(comma "," separated)
Lachu
Registered Member
Posts
864
Karma
1
OS
Currently exists many languages for text formatting. It is used on Wikipedia, etc.

I think developers could use some in comments and KDevelop, when project is properly configured, could parse comments and display not content of comments, but formatted content of comments.


Lachu, proud to be a member of KDE forums since 2008-Nov.
User avatar
raphaelra
Registered Member
Posts
209
Karma
0
OS
Hi :)

What exactly do you mean ? Should KDevelop for example render api inline help as HTML box or use comments to control code folding ?
Lachu
Registered Member
Posts
864
Karma
1
OS
First think is nearly my idea. KDevelop should replace comments text with processed (by formatting language) comment text.

So I can wrote:
Code: Select all
[b]Notice:[/b] [p]You shouldn't call this function directly [br/] Call rather foo [/p]


Of course, this feature will be enabled per-project basis.


Lachu, proud to be a member of KDE forums since 2008-Nov.
User avatar
raphaelra
Registered Member
Posts
209
Karma
0
OS
Lachu wrote:First think is nearly my idea. KDevelop should replace comments text with processed (by formatting language) comment text.
So I can wrote:
Code: Select all
[b]Notice:[/b] [p]You shouldn't call this function directly [br/] Call rather foo [/p]

You mean somenthing more then simple syntax highlighting ?
But how will you then edit the markup in comments when they don't appear in the rendered text ?
Lachu
Registered Member
Posts
864
Karma
1
OS
Yes. I mean simple markup highliting. Edit options could be accessed by moving mouse cursor above comment and select from tooltip edit.


Lachu, proud to be a member of KDE forums since 2008-Nov.
airdrik
Registered Member
Posts
1854
Karma
5
OS
For comments in code, I would suggest either a toggle button in the margin to toggle between comment source code and the new preview mode; or a preview button which pops up the preview of the rendered content.
For actual markup files, you could have a toggle button for the whole file, or have a separate preview pane (such as you might find with the right plugins for the Atom text editor).


airdrik, proud to be a member of KDE forums since 2008-Dec.
Lachu
Registered Member
Posts
864
Karma
1
OS
I also think, it would be nice if there exist documentation text generation form sources, which supports markup adopted by KDevelop. I don't use documentation generating tool, so I don't know they already supports rich text formatting. We have two way:
1. Enhance/create documentation format to support KDevelop text formatting language
2. Select formatting language, which is supported by one of documentation generating tool


Lachu, proud to be a member of KDE forums since 2008-Nov.


Bookmarks



Who is online

Registered users: Bing [Bot], Evergrowing, Google [Bot], rockscient