documentation

I'm trying to create documentation for test Python project before doing it for the real project. My system : Win7 64 bit, python 2.7.5 64 bit. My project name is testDoc . It includes python pakage, named t , which includes 2 modules t1 and t2 and __init__.py . __init__.py contains: import t1 import t2 t1.py contains: ''' Created on 27 2013 @author: ''' class MyClass(object): ''' Hi ''' def __init__(self,selfparams): ''' Constructor ''' pass To create docs I run in the command line in testDoc : sphinx-apidoc -A "me" -F -o docs . Sphinx creates many files and it's ok according to Sphinx docs.

Not sure if I'm even calling this right but I wanted to start adding some documentation to my classes, methods, properties, etc. I know this is probably super obvious but I never really learned it. I'm not sure where to start. Just to clarify whenever you roll over a class (or method, property, etc.) it shows a tooltip in Visual Studio with some documentation on that specific method. class Microsoft.Phone.BackgroundAudio.BackgroundAudioPlayer Provides background access to audio playback functionality such as play, pause, fast-forward, and rewind. What is that called and how can I implement

I have an assembly containing very thorough XML-based documentation, which is used through Sandcastle to generate the help-files for the product. We also use the output XML files for providing proper Intellisense in Visual Studio when programmers use the assembly obviously. In order to do this, it seems we have do both supply the user with the assembly ("assembly.dll") and the documentation ("assembly.xml"). Is it somehow possible to embed the documentation within the assembly, so we'd only have to supply the single assembly-file and Visual Studio would be able to extract the information?

In Sphinx, if I have the following heading declaration: .. _somestuff: ``this is code``, this is not! ============================== It renders, like this: this is code , this is not! Which is good, but, if I use the reference, e.g: Have a look at :ref:`somestuff` It loses the code formatting and renders like: Have a look at this is code, this is not! instead of: Have a look at this is code , this is not! Is it possible to retain the code formatting in the reference? And how would I go about it? If you have a look at :ref: documentation in its official web site about inline markups: :ref: To

I have searched Google and JetBrains website, but I cannot find docs for the com.intellij packages. Any IDEAs (:-))? Thanks to a comment from @Sorin, the official documentation is available here: http://www.jetbrains.org/intellij/sdk/docs/index.html Here are some docs: Lots of links here: http://confluence.jetbrains.net/display/IDEADEV/PluginDevelopment The SDK: http://confluence.jetbrains.net/display/IDEADEV/Getting+Started+with+Plugin+Development Also, from the above link, you can check out the source code to the community edition, which should effectively act as API docs: http://www

We have a number of makefile templates, that realize certain build actions by setting a few parameter makefile variables, and applying a makefile template via inclusion like GENERIC_PARAM1-y := paramA GENERIC_PARAM2-y := paramB include $(MAKE_TOOLS)/doaction.mk And files like doaction.mk contain make templates to generate standard rule definitions that are applied when just including the action make step. Now we want to document these interfaces for the *.mk snippets using Doxygen like ## @file ## @brief doaction.mk is purposed to ... ## ## Some more detailed descriptions about rules applied .