Search Results

Search found 8543 results on 342 pages for 'documentation'.

Page 7/342 | < Previous Page | 3 4 5 6 7 8 9 10 11 12 13 14  | Next Page >

• offline Wordpress documentation

  - by baiano

  I am working on a wordpress theme and am looking for a downloaded set of documentation files so that I can access them even when I don't have access to the internet. I am looking for something similar to the PHP docs found on: http://www.php.net/download-docs.php Does anyone know where I might find something like that for wordpress?

  Read the article

• Selectively suppress XML Code Comments in C#?

  - by Mike Post

  We deliver a number of assemblies to external customers, but not all of the public APIs are officially supported. For example, due to less than optimal design choices sometimes a type must be publicly exposed from an assembly for the rest of our code to work, but we don't want customers to use that type. One part of communicating the lack of support is not provide any intellisense in the form of XML comments. Is there a way to selectively suppress XML comments? I'm looking for something other than ignoring warning 1591 since it's a long term maintenance issue. Example: I have an assembly with public classes A and B. A is officially supported and should have XML documentation. B is not intended for external use and should not be documented. I could turn on XML documentation and then suppress warning 1591. But when I later add the officially supported class C, I want the compiler to tell me that I've screwed up and failed to add the XML documentation. This wouldn't occur if I had suppressed 1591 at the project level. I suppose I could #pragma across entire classes, but it seems like there should be a better way to do this.

  Read the article

• Selectively suppress XML comments?

  - by Mike Post

  We deliver a number of assemblies to external customers, but not all of the public APIs are officially supported. For example, due to less than optimal design choices sometimes a type must be publicly exposed from an assembly for the rest of our code to work, but we don't want customers to use that type. One part of communicating the lack of support is not provide any intellisense in the form of XML comments. Is there a way to selectively suppress XML comments? I'm looking for something other than ignoring warning 1591 since it's a long term maintenance issue. Example: I have an assembly with public classes A and B. A is officially supported and should have XML documentation. B is not intended for external use and should not be documented. I could turn on XML documentation and then suppress warning 1591. But when I later add the officially supported class C, I want the compiler to tell me that I've screwed up and failed to add the XML documentation. This wouldn't occur if I had suppressed 1591 at the project level. I suppose I could #pragma across entire classes, but it seems like there should be a better way to do this.

  Read the article

• What documentation is helpful when supporting an application?

  - by Andrew

  I am going to be taking over from a developer here at work soon. Hence, I'll be supporting all the applications that he has written over the last few years. My question is, when supporting an application that you probably don't know much about, what kind of documentation is most helpful to get a handle on how to fix problems, extend functionality, modify functionality, etc? I'm thinking it would need to give you an overview of what the software does, what interfaces it has to other software, what databases it uses, usernames, passwords, and so on. Is there such a thing as a software support document? Referrals to any templates would be most helpful. BTW, unfortunately, there are no requirements documents, specs, etc! So, really my question is, if my colleague had a day to write a single document for each application so that I could (more easily) support it, what would that document be and/or what would it look like?

  Read the article

• Compiling emails into project documentation

  - by zpinter

  What's the best way to turn a bunch of email threads into a working project documentation? This other stack overflow question seems a little stale, but might be the right idea: http://stackoverflow.com/questions/11612/is-there-any-wiki-engine-that-supports-page-creation-by-email Also, Evernote shared notebooks might be an idea: http://blog.evernote.com/2009/06/25/notebook-sharing-phase-1/ Perhaps there's a good way to convert email threads into HTML or Word docs and save them to a shared dropbox folder? My ideal solution would be one where I could forward or copy a thread of emails into one spot, and go back after the fact to organize/categorize/add to it. Any ideas?

  Read the article

• Documentation generator for Google Closure Javascript

  - by Julius Eckert

  I want to generate a HTML-Documentation for my Javascript code. The comments in my code are written in a format, the Google Closure Compiler can use to optimize my code. Example: /** * Class for handling timing events. * * @param {number=} opt_interval Number of ms between ticks (Default: 1ms). * @param {Object=} opt_timerObject An object that has setTimeout, setInterval, * clearTimeout and clearInterval (eg Window). * @constructor * @extends {goog.events.EventTarget} */ goog.Timer = function(opt_interval, opt_timerObject) { ... } I am looking for something like http://yardoc.org for Javascript. What tools can you recommend? Are there any specific tools for Google Closure code?

  Read the article

• jQuery compatible JavaScript documentation generator

  - by clyfe

  I need to choose a documentation generator (similar to jdoc in java or rdoc in ruby) for my javascript project that (built with jquery, underscore and backbone) Candidates: jsdoc toolkit pdoc natural docs docco YUI doc doctool http://jquery.bassistance.de/docTool/docTool.html other ? Requirements should work with jquery, underscore and backbone. that means object-literal methods etc I really like pdoc but its too centered around prototype, poorly documented, and I don't want to make extra files (sections?) to make it work (not sure about this) docco is nice but I want structured output (as in menu + class/func structure like jdoc) must be command line/makefile compatible (not web pastie) Tips, tricks, tutorials, success stories, advice greatly welcomed. Why Doesn't jQuery use JSDoc?

  Read the article

• Best solution for language documentation.

  - by Simone Margaritelli

  I'm developing a new object oriented scripting language and the project itself is quite ready for audience now, so i'm starting to think about a serious (not as "drafty" as it is right now) way of document its grammar, functions from standard library and standard library classes. I've looked a bit around and almost every language hash its own web application for the documentation, Python uses Sphinx for instance. Which is the best PHP (don't have the time/will to install mod_who_knows_what on my server) application to accomplish this? I've used mediawiki a bit but i found its tag system a little bit hard to use in this context. Thanks for your answers.

  Read the article

• How should important terms be emphasized in documentation?

  - by John Rasch

  Software will often introduce and formalize concepts that may have ambiguous definitions in the real world. For example, in an attendance tracking system, an Occurrence refers to an Excused Absence, an Unexcused Absence, or a Tardy. In technical documentation (both in helper text and in user guides, etc), should these concepts be proper nouns, and as such, should they be capitalized in usage? In other words, which of the following examples is more appropriate: After an Occurrence has been created, it may be converted into an Excused Absence once the Approval Form has been uploaded. or After an occurrence has been created, it may be converted into an excused absence once the approval form has been uploaded.

  Read the article

• ChoiceFormat.setChoices confusion about format parameter type and documentation

  - by polygenelubricants

  From the java.text.ChoiceFormat API: setChoices(double[] limits, String[] formats): Set the choices to be used in formatting. Parameters: limits - contains [...] formats - are the formats you want to use for each limit. They can be either Format objects or Strings. When formatting with object Y, if the object is a NumberFormat, then ((NumberFormat) Y).format(X) is called. Otherwise Y.toString() is called. I'm having difficulties understanding the documentation for the formats parameter: how can you possibly pass a Format/NumberFormat object to setChoices if it's declared String[] formats? Note that interestingly, the getters counterpart of setChoices are declared as follows: double[] getLimits() Object[] getFormats() -- not String[]!!! Is this a bug in the API? Should the setter have been declared setChoices(double[], Object[]) instead, or am I not understanding how to use setChoices correctly?

  Read the article

• Standard documentation of Visual Studio commands?

  - by Borek

  Visual Studio has a concept of commands, i.e. actions executable by pressing a shortcut, entering them on the Command Window etc. Visual Studio itself documents its commands (at least some of them) but I was wondering if there is a unified way to get information about any command, e.g. coming from ReSharper, TestDriven.NET etc. What I'd like to see for every command: Textual description of the command List of parameters and their types/allowed values I've never developed a VS addon / extension so am not sure if this question even makes sense but from the user perspective, some documentation would be greatly appreciated. BTW, is the Command Window the best place to get at least an overview of all the commands available? ToolsOptionsKeyboard is another place where I can see shortcuts also but the UI is not very convenient...

  Read the article

• perf events documentation

  - by Thanatos

  I've searched for an exhaustive explanation of the meaning of each event monitored by the perf stat command; I've found a tutorial which explains quite well how to use different the features of the perf tool. However, it doesn't explain the meaning of several events that can be observed (and there are a lot!!). Someone know where is a quite simple and complete documentation about the events listed by the perf list command? In particular, I'm interested in finding out the percentage of cpu used by some application I wrote. Can i measure it directly through cpu-clock or task-clock? What's the meaning of these two events? Thanks in advance

  Read the article

• Does this make any sense (Apple-documentation)?

  - by Paperflyer

  Here is a snippet of the official Apple Documentation of AudioBufferList (Core Audio Data Types Reference) AudioBufferList Holds a variable length array of AudioBuffer structures. struct AudioBufferList { UInt32 mNumberBuffers; AudioBuffer mBuffers[1]; }; typedef struct AudioBufferList AudioBufferList; Fields mNumberBuffers The number of AudioBuffer structures in the mBuffers array. mBuffers A variable length array of AudioBuffer structures. If mBuffers is defined as AudioBuffer[1] it is not of variable length and thus mNumberBuffers is implicitly defined as 1. Do I miss something here or is this just nonsense?

  Read the article

• Documentation and Build system for Mono/C#

  - by dcolish

  I'm starting out on a new project and a team member has decided to use C# as the implementation language. I don't have a lot of experience in C#, but a brief reading shows that it's very capable of being a complete cross-platform vm. Beyond the language, I've been having trouble selecting tools and workflows for managing the code as the project grows. It should be fairly small (<10K lines) but I would like to have the ability to generate documentation as the project grows, manage any external dependencies that we decide to use, and automate builds and testing. I am wondering what tools are commonly used or considered best practices for this language. I am mainly concerned with how would a build system potentially work on *nix as well as windows? Are there C# specific tools or is Make more common? In addition, I'd like to use a dvcs, but it doesn't look like Visual Studio and MonoDevelop support the same ones. What's the common vcs of choice for C#? For testing sort of Unit testing is available for C#/Mono? Finally, I know that there are good doc generators, but with the question of the build system, I would really like to have that just be a single step in the build similar to how testing is a step. Normally I'd automate with Hudson, but I am wondering if there is something more specific to the platform. Overall, I'd love to see a solution that provides a decent workflow on both windows and *nix without a heavy admin burden. I am pretty sure this is the holy grail of project management, so anything that puts me on that path is awesome.

  Read the article

• Pre Project Documentation

  - by DeanMc

  I have an issue that I feel many programmers can relate to... I have worked on many small scale projects. After my initial paper brain storm I tend to start coding. What I come up with is usually a rough working model of the actual application. I design in a disconnected fashion so I am talking about underlying code libraries, user interfaces are the last thing as the library usually dictates what is needed in the UI. As my projects get bigger I worry that so should my "spec" or design document. The above paragraph, from my investigations, is echoed all across the internet in one fashion or another. When a UI is concerned there is a bit more information but it is UI specific and does not relate to code libraries. What I am beginning to realise is that maybe code is code is code. It seems from my extensive research that there is no 1:1 mapping between a design document and the code. When I need to research a topic I dump information into OneNote and from there I prioritise features into versions and then into related chunks so that development runs in a fairly linear fashion, my tasks tend to look like so: Implement Binary File Reader Implement Binary File Writer Create Object to encapsulate Data for expression to the caller Now any programmer worth his salt is aware that between those three to do items could be a potential wall of code that could expand out to multiple files. I have tried to map the complete code process for each task but I simply don't think it can be done effectively. By the time one mangles pseudo code it is essentially code anyway so the time investment is negated. So my question is this: Am I right in assuming that the best documentation is the code itself. We are all in agreement that a high level overview is needed. How high should this be? Do you design to statement, class or concept level? What works for you?

  Read the article

• JQuery: Current, Well-Formatted, Printable Documentation?

  - by Eli

  Hi All, I'm looking for a current (1.2), well-formatted, printable version of the jQuery documentation. I've checked the alternative resources page and see the PDF versions from CF and Java, but both are out of date. The jQuery site has the API browser with "Printable Version" in the toolbox, but it prints terribly, and I don't really want to print one page or tab at a time. I have a hard time believing that there is no print doc for a tool this popular - all I want is a simple listing with descriptions and examples ON PAPER. Am I missing something? I can buy one of the books if I need to, but not sure which is for the current version. Thanks! Update: I can see that somebody voted this down. I know it's a pretty basic question, but it is not asked lightly or frivolously. I have made a pretty solid effort to find this on my own, and am pretty good at finding information when I need it. Perhaps the person who thought the question not worth asking knows where to find the print doc?

  Read the article

• Need advice - Developing a flexible documentation system, heavily focused on localization

  - by inkedmn

  I've been charged with building a documentation system/platform. Here's a short list of the major requirements: Easily localized : This will need to support a dozen or so languages out of the gate. (the ability for non-technical personnel to add/update translations would be a big plus, though not 100% required) Flexibility in output formats : At the bare minimum, I need to output the documents (either as a whole or in selected chunks) as PDF and HTML. Bonus points for native formats like Windows Help Files. Managed and deployed via an intuitive user interface (web, ideally). I'm wondering if you folks know of any systems out there that support this type of thing already? I'm not averse to writing this from scratch, but I'd rather not reinvent the wheel if I can help it. The two major candidates I've come across thus far are DocBook and reST. The former seems to have garnered a reputation for, well, sucking. I'm unfamiliar with either, but I'm told that reST would get me a good portion of the way there. Any other suggestions? Would I be better off building this from scratch?

  Read the article

• How to manage end user documentation for a project under continuous integration?

  - by mcdon

  I have a project under continuous integration and would like to add end user documentation to the project. The end user documentation is a user manual, not API documentation. In our environment we use windows, c#, msbuild, cruisecontrol.net and subversion. We are currently using DocToHelp to create our help file, which is based on an msword document. I'm looking for some guidance on how to manage the end user documentation. What documentation tools should I use? Should any of the documentation tools be part of the build script? Should the output files from the documentation tool be stored in subversion? What type of help files would be best to use?

  Read the article

• A tool to aid completion of missing or incomplete source code documentation

  - by Pekka

  I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints, interested in tools to help me automate the task as much as possible. The tool I am thinking about would ideally have the following features: Parse a PHP project tree and tell me where there are undocumented files, classes, and functions/methods (i.e. elements missing the appropriate docblock comment) Provide a method to half-way easily add the missing docblocks by creating the empty structures and, ideally, opening the file in an editor (internal or external I don't care) so I can put in the description. Optional: Automatic recognition of parameter types, return values and such. But that's not really required. The language in question is PHP, though I could imagine that a C/Java tool might be able to handle PHP files after some tweaking. Looking forward to your suggestions! Bounty There are already very good suggestions for this (that I have not yet had the time to check out) to point out the gaps, but none yet providing aid in filling them. I want to give the question some more exposure, maybe there is some sort of a graphical extension to php_codesniffer to achieve the level of automation I'm dreaming of. Looking forward to any additional input!

  Read the article

• Mindmapping as a Documentation Tool

  - by mcass20

  My team has recently begun using XMind to organize development projects. It seems to be a pretty powerful brainstorming software. I'm just wondering if other developers have employed similar techniques to aid in documenting software design.

  Read the article

• Tags/Documentation with SVN Project in Eclipse?

  - by Kevin

  I've searched around with this and haven't found any clear answers. I'm using Eclipse PDT. It seems that if I create a PHP Project, tags work (@todo, etc). However, if I create a project from SVN (still PHP based), tags don't work at all. Does anyone know how to make tags and doc generation work on a per project basis and still import projects from a SVN repo?

  Read the article

• Box2d Documentation - Outdated, any better api refs?

  - by GONeale

  Hi guys, I am working with cocos2d + box2d and as I look through the 'Hello World' tutorial and attempt others I am finding many constructs which do not seem to be documented in the latest api ref. Would anybody be able to shed some light on what's going on? or point me in the right direction to someone who has covered the new constructs such as b2PolygonDef changing to b2PolygonShape and likewise for circle + who knows what else, seems there has not been any doc updates since August '09. This is the only information I could find on the issue, of another user stating they have found many mismatches also. http://www.cocos2d-iphone.org/forum/topic/1683

  Read the article

• Documentation of available Ant tasks for Android?

  - by Janusz

  I just accidentally discovered the ant task for test coverage reports with emma. I'm now looking for a target that only invokes the unit test and generates unit testing output. Is there a list with the available ant targets somewhere, or is it possible to look them up somewhere inside the code of the SDK?

  Read the article

• Corporate Wiki Organization - Technical Documentation

  - by Dave Jarvis

  Corporations have documents describing various aspects of their technical systems, including: Custom Applications Custom Development Frameworks Third Party Applications Accounting Bug Tracking Network Management How To Guides User Manuals Software Tools Web Browsers Development IDEs Graphics GIMP xv Text Editing File Transfer ncFTP WinSCP Hardware Servers Web Database Exchange File Network Devices Printers What other items are missing from the list, and how would you organize it? (For example, would Software Tools make more sense under Third Party Applications?) Try to think about where you, a software developer, would expect to find the information by browsing (not searching). A few constraints: The structure should not go beyond three levels deep. Avoid the word "and" in favour of two different categories. Keep the structure general: it should appy as broadly as possible. Target audience is primarily technical.

  Read the article

• A tool to find and fix incomplete source code documentation

  - by Pekka

  I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints, interested in tools to help me automate the task as much as possible. The tool I am thinking about would ideally have the following features: Parse a PHP project tree and tell me where there are undocumented files, classes, and functions/methods (i.e. elements missing the appropriate docblock comment) Provide a method to half-way easily add the missing docblocks by creating the empty structures and, ideally, opening the file in an editor (internal or external I don't care) so I can put in the description. Optional: Automatic recognition of parameter types, return values and such. But that's not really required. The language in question is PHP, though I could imagine that a C/Java tool might be able to handle PHP files after some tweaking. Thanks for your great input!

  Read the article

< Previous Page | 3 4 5 6 7 8 9 10 11 12 13 14  | Next Page >