Comments for Function in Emacs

Posted by Ryan on Stack Overflow See other posts from Stack Overflow or by Ryan
Published on 2012-03-26T12:50:15Z Indexed on 2012/03/27 5:29 UTC
Read the original article Hit count: 157

Filed under:

emacs

|

comments

|

elisp

|

doxygen

|

doc

I'm looking for a way to add comments for my functions in Emacs. Of course doxymacs is a nice candidate. But I prefer another way works without the necessary libs. Can anyone recommend some others ways for adding smart comments for functions in Emacs? Thanks.

Edit: Now I found this: http://nschum.de/src/emacs/doc-mode/, but it seems that it does not work well after I require it into my .emacs and add hook for js-mode. Doesn't it support js functions ?

© Stack Overflow or respective owner

Related posts about emacs

Error while installing emacs23 from Software Center

as seen on Ask Ubuntu - Search for 'Ask Ubuntu'
Trying to install emacs in Software Center Ubuntu 12.04 got this error. installArchives() failed: Selecting previously unselected package emacs23. (Reading database ... (Reading database ... 5% (Reading database ... 10% (Reading database ... 15% (Reading database ... 20% (Reading database ... 25% (Reading… >>> More
Shorten Emacs timeout of ~/.emacs read

as seen on Server Fault - Search for 'Server Fault'
My ~/.emacs start-up file is stored in my AFS home directory. Often when I login to a linux machine I will forget to renew my AFS credentials before attempting to edit a local (non-AFS) file with Emacs. When this happens Emacs will attempt to load ~./emacs but cannot because it is in AFS space where… >>> More
Running emacs in GNU Screen overrides .emacs settings for [home] key binding in FreeBSD 8.2

as seen on Super User - Search for 'Super User'
If I use the following .emacs file, I am able to go to the beginning/end of the current line using the home/end keys as I would expect. (keyboard-translate ?\C-h ?\C-?) (add-to-list 'load-path "/home/sam/programs/go/go/misc/emacs/" t) (require 'go-mode-load) (global-set-key [kp-home] 'beginning-of-line)… >>> More
Emacs 23.1 make error 139 in Mac OS X 10.6.3

as seen on Stack Overflow - Search for 'Stack Overflow'
When I try to compile GNU Emacs 23.1 on my machine with Mac OS X 10.6.3 I repeatedly get the following ending: Directories: /src/emacs-23.1/lisp/. /src/emacs-23.1/lisp/./calc /src/emacs-23.1/lisp/./calendar /src/emacs-23.1/lisp/./emacs-lisp /src/emacs-23.1/lisp/./emulation /src/emacs-23.1/lisp/./erc… >>> More
portable emacs? (emacs server not working)

as seen on Stack Overflow - Search for 'Stack Overflow'
I have seen a few suggestions on making emacs portable (on Windows). I have this in my site-start.el: (defvar program-dir (substring data-directory 0 -4)) (setq inhibit-startup-message t) (setenv "HOME" program-dir) I changed the HOME variable so that not only my .emacs init files (and other init… >>> More

Related posts about comments

SQL Developer Data Modeler: On Notes, Comments, and Comments in RDBMS

as seen on Oracle Blogs - Search for 'Oracle Blogs'
Ah the beautiful data model. They say a picture is worth a 1,000 words. And then we have our diagrams, how many words are they worth? Our friends from the Human Relations sample schema So our models describe how the data ‘works’ – whether that be at a logical-business level, or a… >>> More
Comments on Comments

as seen on Geeks with Blogs - Search for 'Geeks with Blogs'
I almost tweeted a reply to Capar Kleijne's question about comments on Twitter, but realized that my opinion exceeded 140 characters. The following is based upon my experience with extremes and approaches that I find useful in code comments. There are a couple extremes that I've seen and reasons… >>> More
Comments in string and strings in comments

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi there, I am trying to count characters in comments included in C code using Python and Regex, but no success. I can erase strings first to get rid of comments in strings, but this will erase string in comments too and result will be bad ofc. Is there any chance to ask by using regex to not match… >>> More
checkins/recent not returning comments or even counts of comments

as seen on Stack Overflow - Search for 'Stack Overflow'
My application has been using the checkins/recent endpoint to show where all the current users friends are currently at and I had included a button the user could press to comment on a checkin. The button used to have the comment count on it until recently. It seems the checkins/recent endpoint no… >>> More
VS for Database Pros (GDR R2) Removes Sproc Comments (2 replies)

as seen on .NET 247 - Search for '.NET 247'
I have been working with my team to implement Data Dude GDR R2 for managing ALL of the databases for our applications. So far I am very pleased by what we can do with the tool with a single exception. I want to have a header with comments as part of every stored procedure so we can track the history… >>> More