client library has no documentation or even header comments
Bug #1278784 reported by
Mike McCracken
This bug affects 1 person
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| ubuntu-download-manager |
Fix Released
|
High
|
Manuel de la Peña | ||
| ubuntu-download-manager (Ubuntu) |
Fix Released
|
Undecided
|
Unassigned | ||
Bug Description
While working with the header library I had to look at the code for UDM occasionally to figure out how to use the client.
Even though I didn't mind reading the source and have already looked at it for code reviews, there were still some things that tripped me up.
Obviously the library needs API documentation.
Some particular questions that should be answered:
- Where do I start (A: get a u::dm::Manager)
- There are several overloaded createDownload() funcs in Manager. which should I use and when?
- Do I need to do anything else to start a download after I created it?
(A: yes, you need to call start() on the download. No, this wasn't obvious.)
Related branches
lp:~mandel/ubuntu-download-manager/documentation
- PS Jenkins bot: Approve (continuous-integration)
- Diego Sarmentero (community): Approve
-
Diff: 1760 lines (+1125/-84)15 files modifiedubuntu-download-manager-client-tests/ubuntu-download-manager-client-tests.pro (+1/-1)
ubuntu-download-manager-client/ubuntu/download_manager/download.h (+188/-0)
ubuntu-download-manager-client/ubuntu/download_manager/error.h (+294/-38)
ubuntu-download-manager-client/ubuntu/download_manager/manager.h (+184/-4)
ubuntu-download-manager-common/ubuntu/download_manager/auth_error_struct.h (+60/-2)
ubuntu-download-manager-common/ubuntu/download_manager/download_struct.cpp (+0/-3)
ubuntu-download-manager-common/ubuntu/download_manager/download_struct.h (+113/-2)
ubuntu-download-manager-common/ubuntu/download_manager/group_download_struct.cpp (+0/-9)
ubuntu-download-manager-common/ubuntu/download_manager/group_download_struct.h (+68/-4)
ubuntu-download-manager-common/ubuntu/download_manager/http_error_struct.cpp (+2/-2)
ubuntu-download-manager-common/ubuntu/download_manager/http_error_struct.h (+53/-3)
ubuntu-download-manager-common/ubuntu/download_manager/network_error_struct.cpp (+2/-2)
ubuntu-download-manager-common/ubuntu/download_manager/network_error_struct.h (+56/-3)
ubuntu-download-manager-common/ubuntu/download_manager/process_error_struct.cpp (+5/-5)
ubuntu-download-manager-common/ubuntu/download_manager/process_error_struct.h (+99/-6)
| Changed in ubuntu-download-manager: | |
| status: | New → In Progress |
Revision history for this message
| Launchpad Janitor (janitor) wrote | #1 |
| Changed in ubuntu-download-manager (Ubuntu): | |
| status: | New → Fix Released |
| Changed in ubuntu-download-manager: | |
| status: | In Progress → Fix Released |
To post a comment you must log in.
This bug was fixed in the package ubuntu-
---------------
ubuntu-
[ Manuel de la Peña ]
* Improved the documentation of the project. The registerMetaType
function was removed because it is not needed and not used in any
part of the code. const have been added in those methods that simply
are used as getters. The descturtors that can be trusted to the
compiler have been removed to reduce clutter in the code. (LP:
#1278784)
[ Ubuntu daily release ]
* New rebuild forced
[ Diego Sarmentero ]
* Add QML Plugin to manage downloads from applications without C++
backend needed. .
-- Ubuntu daily release <email address hidden> Fri, 21 Mar 2014 05:25:34 +0000