Tag: documentation

638 What is the standard Python docstring format? 2010-10-10T01:10:44.823

242 What is self-documenting code and can it replace well documented code? 2008-10-16T15:24:55.307

181 What are the new documentation commands available in Xcode 5? 2013-10-03T20:14:22.250

151 Using javadoc for Python documentation 2011-03-17T03:22:52.320

141 pandas resample documentation 2013-06-08T16:09:43.760

133 How to document thrown exceptions in c#/.net 2009-01-20T13:39:28.310

129 What to put in a python module docstring? 2010-03-31T23:04:34.843

112 Is a successor for TeX/LaTeX in sight? 2008-11-19T23:59:17.093

105 ffmpeg C API documentation/tutorial 2010-04-14T22:17:54.283

99 How to document a method with parameter(s)? 2012-02-08T14:41:52.990

94 pinterest api documentation 2012-03-30T22:11:41.713

91 Using roxygen2 and doxygen on the same package? 2013-12-20T23:24:20.600

89 Compare and contrast the lightweight markup languages 2009-03-18T17:10:40.913

86 Where to put the doxygen comment blocks for an internal library - in H or in CPP files? 2008-12-10T10:23:42.190

86 How to document class attributes in Python? 2010-06-16T06:58:53.077

84 Ways to synchronize interface and implementation comments in C# 2009-05-05T09:10:09.600

83 How to read API documentation for newbs? 2012-06-07T03:59:17.137

82 Android offline documentation and sample codes 2010-05-24T15:22:59.327

79 Inherit docstrings in Python class inheritance 2010-01-08T04:45:11.930

75 Are there some good and modern alternatives to Javadoc? 2009-06-22T10:55:58.527

74 How can I reference the value of a final static field in the class? 2011-10-23T20:33:50.100

72 Documenting Scala 2.10 macros 2012-12-12T13:22:22.360

71 How do I set the language for the Android developer website? 2015-08-15T22:18:00.263

70 iOS Private API Documentation 2009-07-19T17:19:51.930

70 Node.js request object documentation? 2013-06-22T14:00:43.707

66 How to document Python code with doxygen 2008-09-12T10:26:40.033

64 Doxygen vs Javadoc 2008-10-22T11:54:36.803

64 How do the Mogenerator parameters work, which can I send via Xcode? 2010-08-28T02:49:57.390

63 Using Javascript inside a PDF 2012-02-09T22:26:22.707

63 sphinx-build fail - autodoc can't import/find module 2012-04-25T21:54:39.240

63 How to document magic (_call and _callStatic) methods for IDEs 2013-03-26T09:54:59.690

62 How to automate documentation of a REST API (Jersey Implementation) 2009-11-11T09:22:10.833

62 How to specify an array of objects as a parameter or return value in JSDoc? 2013-01-30T19:20:26.037

61 Syntax for documenting JSON structure 2010-10-17T14:49:07.640

60 Namespace documentation on a .Net project (Sandcastle)? 2008-10-01T07:32:00.290

60 What is the correct way to document a **kwargs parameter? 2009-07-16T12:18:43.433

57 Where are the man pages for C++? 2011-03-14T01:07:11.090

57 Documenting Node.js projects 2011-05-23T11:39:02.340

56 Why are methods in Ruby documentation preceded by a hash sign? 2009-04-09T22:31:41.623

55 How to create multiple levels of indentation in Javadoc? 2011-06-25T15:43:01.777

54 Standard methods for documenting a RESTful API 2009-05-22T15:00:21.247

54 How do I create documentation with Pydoc? 2012-10-23T23:02:16.517

54 How to specify resolution and rejection type of the promise in JSDoc? 2012-10-27T21:37:47.237

53 How do I document a module in Python? 2008-09-04T16:06:48.957

53 How to document a database 2008-12-15T18:25:21.813

53 Taking over a project - What should I ask the previous programmer? 2009-01-12T17:27:34.950

53 jQuery UI Color Picker 2009-06-09T16:31:53.210

52 RESTful API Documentation 2009-12-27T15:52:45.633

51 Best way to document anonymous objects and functions with jsdoc 2010-07-03T12:18:23.260

50 Where should project documentation be stored in a typical maven project 2012-02-03T21:05:45.470

49 Generating HTML documentation from WSDL 2009-03-26T14:45:50.203

49 How to document fields and properties in Python? 2011-05-19T15:10:32.973

48 Documentation-generator for Objective-C? 2009-05-01T22:15:52.460

48 Is there something like the official C documentation? 2010-11-20T17:09:39.220

48 Automatically Generating Documentation for All Python Package Contents 2011-01-06T15:44:02.137

48 Writing Maintainable Event-Driven Code 2011-04-08T15:43:14.927

48 Are there any real alternatives to reStructuredText for Python documentation? 2012-06-22T20:12:27.773

47 reference to generic type in XML code comment 2011-02-17T14:17:04.777

46 Documenting C++/CLI library code for use from c# - best tools and practices? 2009-06-24T19:34:24.220

46 Generating Javascript documentation 2011-04-30T11:42:01.213

46 How to write C++ comments that show up in Intellisense? 2011-12-23T16:48:58.110

46 How can I find out what's causing differences in generated Sandcastle docs? 2013-02-16T19:27:04.513

46 How should I document lists, optionals, and yields using Google-style Sphinx? 2015-12-04T23:38:46.467

45 Do you still use UML? How? What for? 2008-09-19T19:10:37.240

45 What do you consider good API documentation? 2009-10-04T01:21:20.287

45 Android SDK and Developer Guide Offline or PDF 2011-02-11T21:33:53.350

45 When documenting in Roxygen: How do I make an itemized list in @details? 2012-02-13T20:32:42.727

44 Offline documentation for various programming languages? 2009-04-06T20:12:22.400

44 Has anyone used Sphinx to document a C++ project? 2009-05-07T14:37:50.717

44 Visual Studio with DoxyGen for documentation, or should we use something else? 2010-01-08T14:43:46.163

44 Google Calendar render action Template parameter documentation 2014-03-31T09:22:25.683

44 Where is the documentation on Pandas 'Freq' tags? 2016-02-11T12:16:38.583

42 How to add package level comments in Javadoc? 2010-09-06T11:01:29.570

41 Generate Protobuf documentation? 2011-02-14T12:35:09.640

41 Programmatically get Summary comments at runtime 2013-03-24T18:57:07.963

40 WebForm_PostBackOptions documentation 2009-02-02T02:48:37.043

40 How can I list the undocumented modules/classes/constants/methods with yardoc? 2011-04-22T15:21:36.837

40 Multiple functions in one .Rd file 2013-04-10T17:31:37.137

40 Linking to other packages in documentation in roxygen2 in R 2014-08-25T15:12:56.750

39 Application (Not a Markup Language) for Producing a User Manual 2008-12-16T15:36:43.713

39 Should I use @return self, this or the current class? 2011-08-04T17:04:34.697

39 Best way to add developer documentation to your Visual Studio projects 2012-03-16T10:30:32.907

39 Create html documentation for C# code 2013-03-09T21:59:06.677

38 How to convince people to comment their code 2008-10-01T20:41:10.797

38 javadoc: @version and @since 2009-02-23T16:49:16.440

38 Where to document functions in C? 2010-08-25T16:20:19.520

37 Should I document my private methods? 2009-11-16T17:14:23.643

37 Ruby and Ruby on Rails offline API documentation 2010-03-13T17:04:28.113

37 JSDoc adding real code in documentation 2010-06-02T20:21:47.943

36 How good is Subversion at storing lots of binary files? 2009-02-11T20:34:41.313

35 How "self-documenting" can code be without being annoying? 2008-10-17T23:18:53.197

35 Does Microsoft SkyDrive have an API? 2008-11-21T03:04:58.060

35 .NET xml docs - inheriting documentation 2008-11-22T13:53:14.070

35 What tools does your team use for writing user manuals? 2008-11-24T13:24:23.487

35 Retaining inline code inside references in Sphinx 2011-11-11T09:30:08.657

35 Using OpenGL with Python 2012-08-25T12:22:30.540

35 Is Sphinx already suitable for C++ documentation? 2012-10-17T12:03:26.063

34 How to refer to array types in documentation comments 2010-03-02T22:51:16.290

34 Where is the JetBrains IntelliJ openapi documentation? 2010-08-27T14:00:23.540